Я пишу комментарии Javadoc для каждой переменной экземпляра? - PullRequest
0 голосов
/ 15 сентября 2018
private String label = "";
private String color = "";
private double edge = 0;

public Dodecahedron(String labelIn, String colorIn, double edgeIn)

Я получаю сообщение об ошибке, в котором отсутствует комментарий Javadoc.[JavadocVariable] (строки переменных экземпляра и [JavadocMethod]

Есть ли какой-то определенный формат или синтаксис, который мне нужно написать, чтобы избавиться от этой ошибки?

1 Ответ

0 голосов
/ 15 сентября 2018

Комментарии Javadoc начинаются с /** и заканчиваются */.Также принято начинать каждую новую строку с *.Например:

/**
 * The label to use.
 */
private String label = "";
...