Если вы хотите, чтобы ваша документация содержала что-либо, кроме того, что уже очевидно из подписи, единственным полезным инструментом здесь является ... you .Это и немного /// (C #) или ''' (VB) весело. есть инструменты, которые будут генерировать такие вещи, как "получает или устанавливает FrobCount", но в конечном итоге ... что вы думаете, свойство FrobCount {get;set;} сделало?
Кстати, под этим я не подразумеваю «не беспокойтесь о добавлении этих комментариев» - они действительно имеют некоторый смысл ... но я беспокоюсь о том, чтобы вы привыкли просто с использованием автоматического инструмента.В конечном счете, это добавляет очень мало дополнительной ценности.Ценность заключается в знании семантики, ожидаемого использования, побочных эффектов и т. Д. Ни один автоматизированный инструмент не сгенерирует это.