Стиль комментариев для заголовков лицензий в Java

Question

Рекомендуется добавить заголовок лицензии в начало каждого файла, который содержит информацию об авторских правах и лицензировании (например, GPL3 предлагает добавить this). Существует ли стандартный стиль комментариев для использования в заголовке лицензии на Java или я могу использовать все, что мне нравится?

Я знаю, что License Maven Plugin предлагают использовать Javadoc стиле комментарии и это то, что я использую сейчас, но недавно обнаружил, что some projects использование простой многострочный воздает (только один *) вместо этого. Будут ли подобные комментарии Javadoc создавать проблемы при использовании инструмента Javadoc?

Answer 1

Вы должны использовать /* */, он кажется стандартным в большинстве проектов Java с открытым исходным кодом. Javadoc следует использовать для описания классов Java, интерфейсов, конструкторов, методов и полей.

Однако, если вы хотите использовать Javadoc, я думаю, вы можете, и он не будет на вашем пути, если вы поместите оператор импорта сразу после него. Согласно this documentation по вопросу о размещении комментариев:

Общая ошибка заключается в том, чтобы поставить оператор импорта между комментарием класса и объявлением класса. Избегайте этого, поскольку инструмент Javadoc будет игнорировать комментарий к классу.

/** 
* This is the class comment for the class Whatever. 
*/ 

import com.sun; // MISTAKE - Important not to put import statement here 

public class Whatever { 
}