Copy of: google/styleguide#941
In Section 7.1.1 General Form, the style guide shows examples of how Javadoc blocks should look. However, there are a few cases not explicitly mentioned, which makes it unclear if they are acceptable or not.
Cases that need clarification:
- Text immediately after
/**
/** Javadoc starts without a leading asterisk.
* More text...
*/
Should be text allowed immediately after /**?
- Lines inside a Javadoc block without a leading asterisk
/**
Line without asterisk, indentation inconsistent.
*/
Should every line inside a multi-line Javadoc always begin with *, or is it acceptable to omit it?
- Closing
*/ on the same line as content
/**
* Some description. */
Should this be considered valid, or should */ always appear on its own line in multi-line Javadoc blocks?
Based on the examples given, it seems more consistent if:
- all lines in multi-line Javadoc start with
*.
/** should be alone on the line, i.e it should not be followed by any content.
- the closing
*/ is always placed on a separate line.
Could Section 7.1.1 be updated to clarify whether these forms are allowed or not?
Thank you!
Copy of: google/styleguide#941
In Section 7.1.1 General Form, the style guide shows examples of how Javadoc blocks should look. However, there are a few cases not explicitly mentioned, which makes it unclear if they are acceptable or not.
Cases that need clarification:
/**Should be text allowed immediately after
/**?Should every line inside a multi-line Javadoc always begin with
*, or is it acceptable to omit it?*/on the same line as contentShould this be considered valid, or should
*/always appear on its own line in multi-line Javadoc blocks?Based on the examples given, it seems more consistent if:
*./**should be alone on the line, i.e it should not be followed by any content.*/is always placed on a separate line.Could Section 7.1.1 be updated to clarify whether these forms are allowed or not?
Thank you!