Я просматриваю новый код, который я только что написал, и добавляю комментарии NDoc sytle к своим классам и методам. Я надеюсь создать хороший документ в стиле MSDN для справки.
В целом, какие хорошие рекомендации при написании комментариев для класса и метода? Что должны делать комментарии NDoc? Что они не должны сказать?
Я нахожу, что смотрю, что говорят комментарии .NET Framework, но быстро стареет; если бы у меня были хорошие правила для руководства, я мог бы закончить свои документы намного быстрее.