Created
October 18, 2022 02:09
-
-
Save logston/e5f8f30250da2b0e02f794c5a8b42484 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /** | |
| * An example of docs using multiline comments. | |
| **/ | |
| public class MultilineDocs { | |
| /** | |
| * A simple method. | |
| * | |
| * @param arg1 An arg. | |
| **/ | |
| public void aMethod(int arg1) {} // end aMethod() | |
| } // end class MultilineDocs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // An example of docs using single line comments. | |
| public class SinglelineDocs { | |
| // | |
| // A simple method. | |
| // | |
| // @param arg1 An arg. | |
| // | |
| public void aMethod(int arg1) {} // end aMethod() | |
| } // end class SinglelineDocs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ╰─⠠⠵ javadoc MultilineDocs.java | |
| Loading source file MultilineDocs.java... | |
| Constructing Javadoc information... | |
| Building index for all the packages and classes... | |
| Standard Doclet version 18.0.1+0 | |
| Building tree for all the packages and classes... | |
| Generating ./MultilineDocs.html... | |
| MultilineDocs.java:4: warning: use of default constructor, which does not provide a comment | |
| public class MultilineDocs { | |
| ^ | |
| Generating ./package-summary.html... | |
| Generating ./package-tree.html... | |
| Generating ./overview-tree.html... | |
| Building index for all classes... | |
| Generating ./allclasses-index.html... | |
| Generating ./allpackages-index.html... | |
| Generating ./index-all.html... | |
| Generating ./index.html... | |
| Generating ./help-doc.html... | |
| 1 warning | |
| ╰─⠠⠵ javadoc SinglelineDocs.java | |
| Loading source file SinglelineDocs.java... | |
| Constructing Javadoc information... | |
| Building index for all the packages and classes... | |
| Standard Doclet version 18.0.1+0 | |
| Building tree for all the packages and classes... | |
| Generating ./SinglelineDocs.html... | |
| SinglelineDocs.java:2: warning: no comment | |
| public class SinglelineDocs { | |
| ^ | |
| SinglelineDocs.java:2: warning: use of default constructor, which does not provide a comment | |
| public class SinglelineDocs { | |
| ^ | |
| SinglelineDocs.java:8: warning: no comment | |
| public void aMethod(int arg1) {} // end aMethod() | |
| ^ | |
| Generating ./package-summary.html... | |
| Generating ./package-tree.html... | |
| Generating ./overview-tree.html... | |
| Building index for all classes... | |
| Generating ./allclasses-index.html... | |
| Generating ./allpackages-index.html... | |
| Generating ./index-all.html... | |
| Generating ./index.html... | |
| Generating ./help-doc.html... | |
| 3 warnings |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Multiline
Singleline