Для разработчиков программ очень важно прикрепить комментарии к коду. При разработке технологий программисты должны быть необходимы для написания комментариев кода во время разработки проекта, что способствует последующему написанию и использованию кода.
Основные требования:
1. Объединенная форма комментария
На протяжении всего приложения используйте стили с последовательной пунктуацией и структурой для построения аннотаций. Если вы обнаружите, что их спецификации аннотации отличаются от этого документа в других проектах, напишите код в соответствии с этой спецификацией и не пытайтесь ввести новые спецификации в установленную систему спецификации.
2. Содержание комментариев точное и краткое
Содержание должно быть простым, ясным и точным, а значение следует предотвратить от неоднозначности комментариев. Неверные комментарии не только бесполезны, но и вредны.
3. Основные комментарии (должны быть добавлены)
(а) Комментарии для класса (интерфейс)
(б) Комментарий конструктора
(c) Комментарии к методам
(d) Комментарии глобальных переменных
(e) Примечания для полей/атрибутов: Простой код делает простые комментарии, содержание комментариев не более 10 слов, а также, сохранившиеся объекты или
Методы Getter и Setter объектов VO не нужно комментировать. Для конкретных форматов аннотации, пожалуйста, обратитесь к следующим примерам.
4. Специальные комментарии должны быть добавлены (должны быть добавлены)
(а) Типичные алгоритмы должны быть прокомментированы.
(б) Комментарии должны быть сделаны в неясном коде.
(c) Добавьте комментарий к отмечке модификации при изменении кода.
(d) Комментарий в коде, состоящем из петель и логических ветвей.
(e) Интерфейсы, предоставленные другим, должны быть подробно прокомментированы.
Примечание: нет примеров для этого типа формата комментариев. Конкретный формат аннотации определяется на вас, а содержание аннотации должно быть точным и кратким.
5. Формат комментариев:
1) Комментарий одностроения: "// ..."
2) Комментарий блока: "/*…*/"
3) Комментарии документа: "/**…*/"
4) Синтаксис тега TAG Javadoc Comment
@author Описание класса указывает на автора, который разработал модуль класса
@version Описание класса указывает на версию модуля класса
@see Ссылка на описание классов, свойств и методов, то есть связанных темстей
@Param Описание метода Описание параметра в методе
@return Описание метода Описание возвращаемого значения метода
@Exception Описание метода Описание исключений, которые могут быть брошены методом
6. Пример:
/** Создайте класс инструментов для манипулирования массивами, который содержит эту общую функцию для рабочих массивов: наибольшее значение. @author Zhang San @версия v. */ public class arraytool {/ ** Получить максимальное значение массива формирования @param arr вернуть Макс; }}Введите команду, как показано ниже:
Затем проверьте его в следующем каталоге и, наконец, нажмите index.html:
Приведенный выше контент делятся с вами спецификациями комментариев кода Java, надеясь, что он будет полезен для вас.