Как мне писать XML-комментарии, чтобы не повторяться между тегами сводки и возврата? [closed]

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

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

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

Когда цель метода - вычислить значение и вернуть его, я обнаружил, что документирую это следующим образом:

/// 
/// Calculates the widget count.
/// 
/// The control to calculate the widget count of.
/// The widget count.

Здесь тег возвращает не предоставляет никакой новой информации: он просто повторяет то, что в сводке . (Исключение составляют методы, возвращающие bool , где легко объяснить, что означают возвращаемые значения true и false .)

Я что-то упустил? Существует ли стандартный способ формулировки блоков документации XML, чтобы избежать повторения между тегами summary и , возвращающими ?

Как мне писать XML-комментарии, чтобы не повторяться между тегами сводки и возврата? [closed]

0 ответов

Похожие вопросы: