coding-conventions
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
coding-conventions [2011/01/05 03:03] – I'm so bold that i removed the part about $Id$ as it's not done, it doesn't seem necessary and noone seems to add it anyway. mikael.ohman | coding-conventions [2011/03/17 13:43] – mikael.ohman | ||
---|---|---|---|
Line 41: | Line 41: | ||
==== Using comments to document the code ==== | ==== Using comments to document the code ==== | ||
OOFEM uses [[http:// | OOFEM uses [[http:// | ||
+ | |||
+ | If you are overloading methods from another class, you should **leave the documentation empty** and make sure the parameters are named exactly the same. Only write a new documentation field if you have something new to add specifically to the implemented methods. | ||
In general, a special comments should be added straight before each function, variable, class, define, etc. you wish to document. The simplest way is to add a simple comment with a short documentation string for the entry, e.g.: | In general, a special comments should be added straight before each function, variable, class, define, etc. you wish to document. The simplest way is to add a simple comment with a short documentation string for the entry, e.g.: | ||
Line 102: | Line 104: | ||
</ | </ | ||
- | Doxygen will inherit documentation from super classes, so do not add comments unless something specific needs to be said for the implementering | + | Again, |
+ | < | ||
+ | | ||
+ | </ | ||
=== Header file layout === | === Header file layout === |
coding-conventions.txt · Last modified: 2017/11/24 16:45 by bp