Оформление кода Java

• Имена классов и интерфейсов начинаются с большой буквы.
• Имена пакетов, переменных, методов начинаются с маленькой буквы.
• Константы пишутся заглавными буквами.
• Имена интерфейсов начинаются с буквы I, тогда когда имеет смысл отличать их от классов.

Комментарии

Программа может быть документирована путем вставки комментариев в релевантные места исходного кода. Эти комментарии используются только в целях документации исходного кода и игнорируются компилятором. В Java есть три вида комментариев:

• Однострочный комментарий: // ... to the end of the line
• Многострочный комментарий: /* ... */
• Документационный (Javadoc) комментарий: /** ... */

Single-Line Comment

Пример однострочного комментария:

// This comment ends at the end of this line.
int age; // From comment-start sequence to the end of the line is a comment.

Multiple-Line Comment

Пример многострочного комментария:

/* A comment
   on several
   lines.
*/

Последовательности с которых начинаются комментарии (//, /*, /**) никак не обрабатываются внутри комментариев, поэтому вложенные многострочные комментарии приводят к синтаксической ошибке:

/* Formula for alchemy.
   gold = wizard.makeGold(stone);
   /* But it only works on Sundays. */
*/

Последняя последовательность */ осталась без соответствующей ей открывающей последовательности.

Documentation Comment

Документационный комментарий (documentation comment) используется инструментом javadoc для генерации HTML-документации. Такие комментарии обычно ставятся перед классами, интерфейсами, методами, полями. Можно использоваться теги для предоставления специальной информации.

/**
  * This class implements a gizmo.
  * @author K.A.M.
  * @version 4.0
  */