Генерация xml-комментариев в С++ в VS
От: flashnik  
Дата: 21.11.09 15:20
Оценка:
При работе с .Net платформой в Visual Studio удобно писать XML-комментарии. Достаточно нажать "///". А не встречал ли кто-нибудь подобной удобной штуки для unmanaged C++ ? В виде плагина, например?
Re: Генерация xml-комментариев в С++ в VS
От: bnk СССР http://unmanagedvisio.com/
Дата: 22.11.09 08:50
Оценка: +1 -1
Здравствуйте, flashnik, Вы писали:

F>При работе с .Net платформой в Visual Studio удобно писать XML-комментарии. Достаточно нажать "///". А не встречал ли кто-нибудь подобной удобной штуки для unmanaged C++ ? В виде плагина, например?


1. IMHO, комментарий над каждой функции в обычном коде — Зло. А XML-комментарии — это Зло Двойное
2. Как насчет Visual Assist -> Document Method? (шаблон и кнопку AFAIR можно настроить)
3. doxycomment? (это для комментариев в стиле doxygen)
Re[2]: Генерация xml-комментариев в С++ в VS
От: Kernan Ниоткуда https://rsdn.ru/forum/flame.politics/
Дата: 25.11.09 14:58
Оценка:
Здравствуйте, bnk, Вы писали:

bnk>Здравствуйте, flashnik, Вы писали:


F>>При работе с .Net платформой в Visual Studio удобно писать XML-комментарии. Достаточно нажать "///". А не встречал ли кто-нибудь подобной удобной штуки для unmanaged C++ ? В виде плагина, например?


bnk>1. IMHO, комментарий над каждой функции в обычном коде — Зло. А XML-комментарии — это Зло Двойное

Почему? Раньше добром было. Времена изменились?
Sic luceat lux!
Re[3]: Генерация xml-комментариев в С++ в VS
От: bnk СССР http://unmanagedvisio.com/
Дата: 25.11.09 16:16
Оценка:
Здравствуйте, Kernan, Вы писали:

bnk>>1. IMHO, комментарий над каждой функции в обычном коде — Зло. А XML-комментарии — это Зло Двойное

K>Почему? Раньше добром было. Времена изменились?

Ничего не изменилось.

"Шапочные" комментарии к функциям IMHO всегда были злом, так как их невозможно поддерживать в актуальном состоянии. Фактически, они "пишутся один раз при создании функции". Их не обновляют. Грустно, но факт. А в результате через несколько лет обнаруживаешь, что лучше было бы вообще без комментариев, чем с такими вот.
А XML-комментарии к тому же еще и нечитабельные.

IMHO, поддержка таких комментариев может иметь смысл только для библиотек, предназначенных для широкой аудитории.

ЗЫ. Обсуждалось уже много раз... К тому же это IMHO.
Re[4]: Генерация xml-комментариев в С++ в VS
От: Kernan Ниоткуда https://rsdn.ru/forum/flame.politics/
Дата: 30.11.09 14:16
Оценка:
Здравствуйте, bnk, Вы писали:

bnk>Здравствуйте, Kernan, Вы писали:


bnk>>>1. IMHO, комментарий над каждой функции в обычном коде — Зло. А XML-комментарии — это Зло Двойное

K>>Почему? Раньше добром было. Времена изменились?

bnk>Ничего не изменилось.


bnk>"Шапочные" комментарии к функциям IMHO всегда были злом, так как их невозможно поддерживать в актуальном состоянии. Фактически, они "пишутся один раз при создании функции". Их не обновляют. Грустно, но факт. А в результате через несколько лет обнаруживаешь, что лучше было бы вообще без комментариев, чем с такими вот.

bnk>А XML-комментарии к тому же еще и нечитабельные.

bnk>IMHO, поддержка таких комментариев может иметь смысл только для библиотек, предназначенных для широкой аудитории.


bnk>ЗЫ. Обсуждалось уже много раз... К тому же это IMHO.

ну это решается просто. Инспекции и внимание к комментариям хотя бы в открытом и защищённом интерфейсе. Можно для упрощения писать что фнкция делает без описания входящих параметром (их имена, типы и способ передачи должны говорить сами за себя)
Sic luceat lux!
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.