Rosetta Code

Documentation: Difference between revisions

Page Discussion

Documentation (view source)

Revision as of 16:55, 27 July 2013

60 bytes added ,  10 years ago
Updated D entry
(Updated D entry)
Line 136:
D compiler comes with a builtin documentation system called [http://digitalmars.com/d/1.0/ddoc.html Ddoc]. Alternative systems may be used (a common alternative is [http://www.stack.nl/~dimitri/doxygen/ Doxygen] which includes some D support).
<lang d>/**
* This is a documentation comment for somefuncsomeFunc and somefunc2someFunc2.
$(DDOC_COMMENT comment inside a documentation comment
* Does not need to be preceded by '*' in every line - this is done purely for code style
* $(DDOC_COMMENT comment inside a documentation comment (results in a HTML comment not displayed by the browser))
 
* Header:
* content (does not need to be tabbed out; this is done for clarity of the comments and has no effect on the
* of the comments and has no effect on the resulting documentation)
* Params:▼
 
* arg1 = Something (listed as "int <i>arg1</i> Something")▼
▲ * Params:
* arg2 = Something else▼
▲ * arg1 = Something (listed as "int <i>arg1</i> Something")
* Returns:▼
▲ * arg2 = Something else
* Nothing▼
 
* TODO:▼
▲ * Returns:
* Nothing at all▼
▲ * Nothing
* BUGS:
 
* None found▼
▲ * TODO:
*/▼
▲ * Nothing at all
void somefunc(int arg1, int arg2)▼
 
{
BUG:
}▼
▲ * None found
// this groups this function with the above (both have the same doc and are listed together)▼
▲ */
▲void somefuncsomeFunc(int arg1, int arg2) {}
 
▲// thisThis groups this function with the above (both have the same doc and are listed together)
// same doc and are listed together)
/// ditto
void somefunc2someFunc2(int arg1, int arg2) {}
 
{
/// Sum function.
int sum(in int x, in int y) pure nothrow {
return x + y;
▲}
 
// These unittests will become part of sum documentation:
///
unittest {
assert(sum(2, 3) == 5);
}
 
/++ Another documentation comment +/
void main() {}</lang>
{
}</lang>
 
=={{header|Delphi}}==
Retrieved from "https://rosettacode.org/wiki/Special:MobileDiff/127585"