Что следует прокомментировать в приложении ASP.NET MVC?

Question

Вот список точек, которые мне интересны.

Должны ли мы оставлять комментарии к методам действий нашего контроллера?

Причина, по которой я спрашиваю об этом, заключается в том, что методы действия очень понятны, и лучший комментарий, который я могу придумать, будет что-то вроде «Возвращает представление для продуктов». Кажется, вызывает беспорядок и не очень помогает.

Должны ли мы иметь какие-либо комментарии в представлениях?

Когда visual studio генерирует методы действий, она автоматически добавляет комментарии, например ...

    //
    // GET: /Products/

... это ^ хорошая практика?

Любые советы / рекомендации по комментированию / документированию приложений ASP.NET MVC?

Я сделал Google для получения информации об этом, но не нашел ничего полезного, поэтому я спрашиваю здесь.

Answer 1

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

Answer 2

Я обычно избавляюсь от этих автоматически сгенерированных комментариев.Я бы сказал, что вы должны следовать тем же принципам с кодом MVC, что и обычный код:

• Если цель и функция метода очевидны из его названия, не комментируйте его.
• Если очевидно, что делает строка кода и почему, не комментируйте ее.
• Если есть вероятность, что метод будет иметь ожидания, которые не сразу очевидны, илиможет иметь менее очевидные вторичные последствия, прокомментируйте это.
• Если неясно что делает строка кода, измените код, чтобы он был более понятным.* Если не очевидно почему вы делаете то, что делаете, добавьте комментарий.