Readable code is very important for every project. The aim is for good code that explains itself. Javadoc comments provide structural documentation for public APIs, while inline comments are desired only in complex or misleading cases.
JSDoc comments are written above all exposed methods and variables in the frontend. Javadoc comments are written above all public methods and classes in the backend. Code is to be written as readable as possible, therefore inline comments are only to be used in complex or misleading cases. Test classes and methods are excluded from this ADR.
ADR-13 Use-Comments
Context
Readable code is very important for every project. The aim is for good code that explains itself. Javadoc comments provide structural documentation for public APIs, while inline comments are desired only in complex or misleading cases.
Decision
JSDoc comments are written above all exposed methods and variables in the frontend. Javadoc comments are written above all public methods and classes in the backend. Code is to be written as readable as possible, therefore inline comments are only to be used in complex or misleading cases. Test classes and methods are excluded from this ADR.
Consequences