Форум программистов [Powered by Invision Power Board]

Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате

Форум программистов > .NET для новичков > Описания

Автор: STRELOKBMSTU 13.12.2007, 14:55

Ко многим методам и классам встречал описания следующего вида:

Код


        /// <summary>
        /// texttexttexttexttexttexttexttexttexttexttexttexttexttexttext
        /// texttexttexttexttexttexttext <see cref="texttexttexttexttexttexttexttext"/>
        /// </summary>
        /// <param name="str">Input string</param>
        /// <returns>string</returns>
        /// <remarks>
        /// texttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttexttext
        /// texttexttexttexttexttexttexttext        /// </remarks>

Вопрос следующий, это определенная структура тегов, признанная всеми? Где можно узнать полный список таких тегов? Значит существуют какие-то программы, понимающие данный синтаксис (или к примеру при десериализации это как-то улавливается?)?

Автор: Baa 13.12.2007, 15:04

The XML doc comments are not metadata; they are not included in the compiled assembly and therefore they are not accessible through reflection.

При компиляции с ключем /doc:filename создается документация, основанная на этих коментариях. Есть специальный софт, типа NDoc, который их может преобразовывать в нормальный хелп.
Посмотреть все теги, как бы это не было удивительно, можно в мсдн.

Автор: tol05 13.12.2007, 15:10

http://rsdn.ru/article/devtools/CSxmlcmnt.xml
http://msdn.microsoft.com/msdnmag/issues/02/06/XMLC/
ну и в учебниках. Троелсен, например.