Документирование геттеров и сеттеров [закрыто]

Закрыт . Этот вопрос основан на мнении . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост .

Закрыто в прошлом году .

Для простых получателей / установщиков, как показано ниже, как лучше всего это документировать?

public float getPrice()
{
    return price;
}

Я довольно строг в отношении стандартов кодирования, поэтому моя IDE предупреждает меня о любых недокументированных открытых / защищенных методах.

Вариант 1:

/**
 * Get the price field.
 * 
 * @return
 */

Вариант 2:

/**
 * @return Price
 */

Или вообще не документировать это?

задан derekerdmann 30 August 2010 в 01:40

0 ответов

Другие вопросы по тегам: