cod
cod copied to clipboard
Support for single-line comments and JavaDoc-like style
Suppose your language only supports single-line comments that start with #.
Your docs might look something like this:
##
# @MyClass
#
# I can see why some might prefer this.
#
##
But you may also just want this:
/**
* @MyClass
*
* "It just looks tidier," some might say.
*
*/
I'd propose another option called "trim" that is a string to remove from the beginning of any line.
The default should be * and it should always be optional; i.e. this will still work:
/**
* @MyClass
*
* "It just looks tidier," some might say.
*
*/
/**
@MyClass:property
But here I just didn't feel like using that style.
*/