[JAVA] Notes on how to write comments in English


Since the comments of the program are basically written in English, Make a note for yourself

Class header comment

Class of system that holds information

 * This class is used to hold the ***.

Class of system to provide

 * Provides ***.

Interface class

 * Defines a *** interface.
 * That any implementation of this interface can be used by inheritor's to handle a ***.

Method comment

Flag setting related

 * Sets flag indicating whether *** is ***.

Judgment relationship

 * Determines if *** is *** or not.
 * @return Returns {@code true} if *** is ***, {@code false} otherwise.

Judgment relationship 2

 * Checks whether the given *** can be ***.
 * @return Returns {@code true} if the given *** can be ***, {@code false} if they cannot be ***.

Relationship to get something

 * Gets the *** with the given {@code ***}.
 * @return Returns the ***. Returns {@code null} if *** doesn't have a specified ***.


enum system

 * Enumeration for ***.

Recommended Posts

Notes on how to write comments in English
How to write java comments
[Ruby on Rails] How to write enum in Japanese
Notes on how to use regular expressions in Java
[Rails] How to write in Japanese
Rails on Tiles (how to write)
How to write Rails
JUnit 5: How to write test cases in enum
Notes on how to use each JUnit Rule
How to write dockerfile
How to write docker-compose
How to write Mockito
How to write migrationfile
[Ruby on Rails] How to install Bootstrap in Rails
[Java] Memo on how to write the source
How to write Java String # getBytes in Kotlin?
Notes on how to create Burp Suite extensions
Javaer tries to summarize how to write properties in C #
[Java] Types of comments and how to write them
[Ruby On Rails] How to reset DB in Heroku
How to write a date comparison search in Rails
How to write an external reference key in FactoryBot
How to write a core mod in Minecraft Forge 1.15.2
How to write good code
Bit Tetris (how to write)
How to deploy on heroku
[Refactoring] How to write routing
Great poor (how to write)
[Note] How to write Dockerfile/docker-compose.yml
How to write Junit 5 organized
How to write Rails validation
How to write Rails seed
[Ruby] How to write blocks
How to write Rails routing
How to run npm install on all projects in Lerna
How to write and notes when migrating from VB to JAVA
How to switch Java in the OpenJDK era on Mac
[Rails5] japanMap link How to write parameters in js.erb file
[Rails] How to write user_id (foreign key) in strong parameter
How to write comments in the schema definition file in GraphQL Java and reflect them in GraphQL and GraphQL Playground
How to use Lombok in Spring
How to find May'n in XPath
How to deploy jQuery on Rails
How to hide scrollbars in WebView
How to run JUnit in Eclipse
How to iterate infinitely in Ruby
Studying Java # 6 (How to write blocks)
How to "hollow" View on Android
How to run Ant in Gradle
[Java] How to update Java on Windows
How to master programming in 3 months
How to install ImageMagick on Windows 10
How to use Ruby on Rails
How to deploy Bootstrap on Rails
How to run JavaFX on Docker
How to learn JAVA in 7 days
How to get parameters in Spark
Baseball ball count (how to write)
How to use Bio-Formats on Ubuntu 20.04
How to install Bootstrap in Ruby
How to write a ternary operator