Skip to content

Commit 066738c

Browse files
committed
docs: update javadoc conventions to README.md
1 parent 2e0e5a4 commit 066738c

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
@@ -84,6 +84,8 @@ The following are lists of conventions that either *should* be followed or *must
8484
- Constructors
8585
- `static` functions
8686
- Instance methods
87+
- Interfaces:
88+
- Names must begin with `I` and continue in `PascalCase`
8789
- `static` Constants:
8890
- Names must be `SCREAMING_SNAKE_CASE`
8991
- Instance Attributes and Method Parameters:
@@ -119,4 +121,5 @@ The following are lists of conventions that either *should* be followed or *must
119121
- all `private` members of which the purpose is not obvious or the logic is difficult to comprehend
120122
- May be added to:
121123
- `public static` constants
122-
- other `private` members
124+
- other `private` members
125+
- Should explain **what** the code does and maybe **why**, but never **how**

0 commit comments

Comments
 (0)