Программирование - это просто
Advertisement
Главная arrow Уроки C# arrow Приемы, рецепты и полезные советы по C#. arrow Полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.
06.10.2022 г.
Главное меню
Главная
Интернет магазин
Программные продукты
Биржевые роботы
Искусственный интеллект
Математика и информатика
1С:Предприятие
Уроки C#
Уроки Delphi
Уроки программирования
Web-программирование
Дизайн и графика
Компьютер для блондинок
Исходники
Статьи
Платный раздел
Рассказы про компьютеры
Хитрости и секреты
Системный подход
Размышления
Наука для чайников
Друзья сайта
Excel-это не сложно
Все о финансах
.
Полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010. Печать E-mail
Автор megabax   
07.04.2012 г.
В этой статье я постараюсь максимально просто и понятно изложить основы программирования на языке Delphi

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

 

В Visual Studio 2010 есть возможность автоматически создавать документацию из комментариев к классам и их методам. Для того, что бы возможно было создавать документацию, комментарии необходимо начинать не с "//", а с "///", при чем в комментариях используются специальные тэги. Вот пример такого вот комментария:

    /// <summary>

    /// Мой пробный класс

    /// </summary>

    public class MySampleClass

    {

        /// <summary>

        /// Мой пробный метод. Он выводит сообщения

        /// </summary>

        /// <param name="str">Сообщение, которое выводит мой пробный метод</param>

        public void MySampleMethod(String str)

        {

            MessageBox.Show(str);

        }

    }

Что нам дают такие комментарии? Во первых, если мы используем созданный класс, то автоматически получаем о нем подсказки*:

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Если выбираем метод класса, так же получаем о нем подсказки*:

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Если заполняем аргументы метода, так же получаем подсказки*:

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Круто, не правда ли? Но это еще не все. Мы можем при компиляции сгенерировать XML-файл документации. Для этого нам нужно зайти в свойства проекта*:

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Переключаемся на закладку "Построение" и где то внизу (прокрутите скроллер) увидим возможность включить генерацию XML-документации*:

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Теперь при компиляции у нас будет сгенерирован файл (по умолчанию он кладетсян в ту же папку, что и экзешники):

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Как видим, наши комментарии попали в файл документации:

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Встает вопрос, а для чего вообще нужна такая XML-документация? Во первых, если вы распространяете свои библиотеки без исходным кодов, то формирование XML-документации необходимо, что бы у пользователя отображались подсказки. Без XML-документации пользователь просто не увидит этих подсказок.. А во вторых, XML - документацию можно скомпилировать и превратить в chm-файл (полноценный файл справки):

Приемы, рецепты и полезные советы по C#. Урок 2. Автоматизированное создание документации в Visual Studio 2010.

Но как скомпилировать такой файл справки, я расскажу в будущих уроках.


Скриншоты, помеченные знаком *, являются цитатами и иллюстрациями  программного продукта "Microsoft Visual Studio 2010 Professional", авторское право на который принадлежит корпорации Microsoft.. 


 

 

Последнее обновление ( 07.04.2012 г. )
 
« След.   Пред. »
 
© 2022 Программирование - это просто
Joomla! - свободное программное обеспечение, распространяемое по лицензии GNU/GPL.
Русская локализация © 2005-2008 Joom.Ru - Русский Дом Joomla!
Design by Mamboteam.com | Powered by Mambobanner.de
Я принимаю Яндекс.Деньги