Skip to content
This repository was archived by the owner on May 28, 2022. It is now read-only.

Commit 9d4b883

Browse files
authored
CodingStandard-Java: Comments: fix numbering of rules
1 parent b635402 commit 9d4b883

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

codingStandards/CodingStandard-Java.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -879,7 +879,7 @@ Omitting braces can lead to subtle bugs.
879879

880880
== *Comments*
881881

882-
*2. {star} All comments should be written in English.*
882+
*1. {star} All comments should be written in English.*
883883

884884
Furthermore, use American spelling and avoid local slang.
885885

@@ -888,7 +888,7 @@ Furthermore, use American spelling and avoid local slang.
888888
The code is meant for an international audience.
889889
====
890890

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.*
892892

893893
You MUST write header comments for all classes, public methods.
894894

@@ -897,14 +897,14 @@ You MUST write header comments for all classes, public methods.
897897
`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.
898898
====
899899

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.*
901901

902902
[NOTE,caption=Rationale]
903903
====
904904
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.
905905
====
906906

907-
*3. {star}{star} Javadoc comments should have the following form:*
907+
*4. {star}{star} Javadoc comments should have the following form:*
908908

909909
[source,java]
910910
----
@@ -943,7 +943,7 @@ Javadoc of class members can be specified on a single line as follows:
943943
private int connectionCount;
944944
----
945945

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.*
947947

948948
[cols="a,a,a"]
949949
|===

0 commit comments

Comments
 (0)