Skip to content

Commit 4bdc827

Browse files
committed
docs: add java comment conventions to README.md
1 parent 066738c commit 4bdc827

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,7 @@ The following are lists of conventions that either *should* be followed or *must
122122
- May be added to:
123123
- `public static` constants
124124
- other `private` members
125-
- Should explain **what** the code does and maybe **why**, but never **how**
125+
- Should explain **what** the code does and maybe **why**, but never **how**
126+
- Comments:
127+
- Should be avoided except for Javadoc
128+
- Necessary information regarding behavior should be added as Javadoc instead (e.g. `@apiNote`, `@implNote`, `@implSpec`)

0 commit comments

Comments
 (0)