You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 28, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: codingStandards/CodingStandard-Java.adoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -879,7 +879,7 @@ Omitting braces can lead to subtle bugs.
879
879
880
880
== *Comments*
881
881
882
-
*2. {star} All comments should be written in English.*
882
+
*1. {star} All comments should be written in English.*
883
883
884
884
Furthermore, use American spelling and avoid local slang.
885
885
@@ -888,7 +888,7 @@ Furthermore, use American spelling and avoid local slang.
888
888
The code is meant for an international audience.
889
889
====
890
890
891
-
*1. {star}{star} Write descriptive header comments for all public classes/methods.*
891
+
*2. {star}{star} Write descriptive header comments for all public classes/methods.*
892
892
893
893
You MUST write header comments for all classes, public methods.
894
894
@@ -897,14 +897,14 @@ You MUST write header comments for all classes, public methods.
897
897
`public` method are meant to be used by others and the users should not be forced to read the code of the method to understand its exact behavior. The code, even if it is self-explanatory, can only tell the reader HOW the code works, not WHAT the code is supposed to do.
898
898
====
899
899
900
-
*2. {star}{star}{star} All non-trivial private methods should carry header comments.*
900
+
*3. {star}{star}{star} All non-trivial private methods should carry header comments.*
901
901
902
902
[NOTE,caption=Rationale]
903
903
====
904
904
Writing header comments will hep novice programmers to self-detect abstraction problems. e.g. If it is hard to describe the method succinctly, there is something wrong with the method abstraction.
905
905
====
906
906
907
-
*3. {star}{star} Javadoc comments should have the following form:*
907
+
*4. {star}{star} Javadoc comments should have the following form:*
908
908
909
909
[source,java]
910
910
----
@@ -943,7 +943,7 @@ Javadoc of class members can be specified on a single line as follows:
943
943
private int connectionCount;
944
944
----
945
945
946
-
*4. {star} Comments should be indented relative to their position in the code.*
946
+
*5. {star} Comments should be indented relative to their position in the code.*
0 commit comments