It's possible to use Remarks:-Keyword within Method-documentation section. This way additional information can be added to Method-documentation. This is especially useful if you want to add structure to your remarks using Markup:
/*!
Method: test(x)
bla
Parameters:
x - *(Optional)* bla
Remarks:
### See also:
[test2](#test2)
### Author(s)
* 20130308 - [hoppfrosch](hoppfrosch@anywhere.com) - bla
*/
I failed to find a way to add something similar to the class- or library-documentation block ..
Wouldn't it make sense to support Remarks:-Keyword within method as well as property, class and library documentation (what else?) sections to get some consistency and make usage of Remarks: more intuitive?
It's possible to use
Remarks:-Keyword withinMethod-documentation section. This way additional information can be added toMethod-documentation. This is especially useful if you want to add structure to your remarks using Markup:I failed to find a way to add something similar to the
class- orlibrary-documentation block ..Wouldn't it make sense to support
Remarks:-Keyword withinmethodas well asproperty,classandlibrarydocumentation (what else?) sections to get some consistency and make usage ofRemarks:more intuitive?