Комментарии к коду в ASP .Net проектах - PullRequest
1 голос
/ 06 января 2011

Я привык работать над своими небольшими проектами, где я обычно являюсь единственным участником, но сейчас я работаю над проектом ASP .Net C #, где другие будут работать с моим кодом позже.

Я действительно считаю, что комментирую свой код C # профессионально, но я никогда не удосужился писать комментарии на своих страницах ASPX, за исключением кода JavaScript.

Существует ли какой-либо "стандарт" в ASP.С кем работают сетевые разработчики?

Нужно ли в комментариях добавлять информацию о действиях, сгенерированных в Code Behind, чтобы упростить чтение страницы или это излишество?

Спасибо, Стефан

Ответы [ 2 ]

4 голосов
/ 06 января 2011

Стремитесь к самодокументируемому коду (требуется меньше комментариев).

Следуйте распространенным схемам (внутри компании или в промышленности)

Используйте (экономно) комментарии «намерения высокого уровня» для объяснения неочевидного кода.

0 голосов
/ 06 января 2011

Понять, что (возможно) требует объяснения, если смотреть другим. Используйте плагин GhostDoc для быстрого написания комментариев, но не забудьте проверить комментарии, написанные плагином. Комментарии должны быть самоочевидными.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...