C. Javadoc Comments Java introduces a new type of comment known as javadoc comments. Javadoc comments are meant to make your code somewhat self-documenting. The HTML pages created describe the classes, methods, and variables you define. When you look at the Java API documentation, you are in fact reading HTML pages created from the original source code by using the javadoc tool. A function that returns a boolean value can often be named by the question that it answers.
Some examples follow.
These are not the only possibilities, but should give you an idea of what we expect. Functions should also have prologs before their header statements, preferably in javadoc format. Function prologs should include a list of formal parameters. In a well modularized program, the prolog may be the only comment needed within a function. The convention is widely used with the C programming language, especially in Microsoft Windows programming.