Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | Last revision Both sides next revision | ||
|
en:entwickler:sourcecode-dokumentation [2015/11/30 10:07] ximex [Documenting Parameters] |
en:entwickler:sourcecode-dokumentation [2015/11/30 10:08] ximex [Format Comments for Doxygen] |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| ==== Format Comments for Doxygen ==== | ==== Format Comments for Doxygen ==== | ||
| - | Comments must be specially marked so that they are recognized and processed by Doxygen as relevant. This is useful, but really only in class, method and function descriptions. This requires the comment normally is to be supplemented front of the class, method or function with special characters. <code php> // Description for subsequent function, as it was previously available in the source code. | + | Comments must be specially marked so that they are recognized and processed by Doxygen as relevant. This is useful, but really only in class, method and function descriptions. This requires the comment normally is to be supplemented front of the class, method or function with special characters. |
| - | function foo($param)</code> From this line of code should be the following syntax: <code php> /// Description for subsequent function, as it is optimized for Doxygen | + | <code php> |
| - | function foo($param)</code> Once there, however, more than one line, following Doxygen comment optimized code should be used: <code php> / ** Description for subsequent function, as it is optimized for Doxygen | + | // Description for subsequent function, as it was previously available in the source code. |
| - | * And more than one line | + | function foo($param) |
| - | * / | + | </code> |
| - | function foo($param)</code>In a one-line comment a 3. Slash is appended, multiline comment at the beginning a 2nd asterisk.Now the comment will be considered in Doxygen. | + | From this line of code should be the following syntax: |
| + | <code php> | ||
| + | /// Description for subsequent function, as it is optimized for Doxygen | ||
| + | function foo($param) | ||
| + | </code> | ||
| + | Once there, however, more than one line, following Doxygen comment optimized code should be used: | ||
| + | <code php> | ||
| + | /** | ||
| + | * Description for subsequent function, as it is optimized for Doxygen | ||
| + | * And more than one line | ||
| + | */ | ||
| + | function foo($param) | ||
| + | </code> | ||
| + | In a one-line comment a 3. Slash is appended, multiline comment at the beginning a 2nd asterisk.Now the comment will be considered in Doxygen. | ||
| ==== Documenting Parameters ==== | ==== Documenting Parameters ==== | ||
