Documentation: Difference between revisions

Content added Content deleted

Inline

@@ Line 136: / 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 somefunc and somefunc2.
+This is a documentation comment for someFunc and someFunc2.
+$(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))
+(results in a HTML comment not displayed by the browser))
- * Header:
+Header:
- *     content (does not need to be tabbed out; this is done for clarity of the comments and has no effect on the
+    content (does not need to be tabbed out; this is done for clarity
- *     resulting documentation)
+    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 someFunc(int arg1, int arg2) {}
+// This groups this function with the above (both have the
+//  same doc and are listed together)
 /// ditto
-void somefunc2(int arg1, int arg2)
+void someFunc2(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()
+void main() {}</lang>
-{
-}</lang>
 =={{header|Delphi}}==