Основы программирования на C#


Консольный проект - часть 2


using System; namespace ConsoleHello { /// <summary> /// Первый консольный проект - Приветствие /// </summary> class Class1 { /// <summary> /// Точка входа. Запрашивает имя и выдает приветствие /// </summary> static void Main() { Console.WriteLine("Введите Ваше имя"); string name; name = Console.ReadLine(); if (name=="") Console.WriteLine ("Здравствуй, мир!"); else Console.WriteLine("Здравствуй, " + name + "!"); } } }

Я изменил текст в тегах <summary>, удалил атрибут и аргументы процедуры Main, добавил в ее тело операторы ввода-вывода. Благодаря предложению using, мне не требуется при вызове методов класса Console каждый раз писать System.Console. Надеюсь, что программный текст понятен без дальнейших пояснений.

В завершение первого проектa построим его XML-отчет. Для этого в свойствах проектa необходимо указать имя файла, в котором будет храниться отчет. Установка этого свойства проектa, так же как и других свойств, делается в окне Property Pages, открыть которое можно по-разному. Я обычно делаю это так: в окне Solution Explorer выделяю строку с именем проектa, а затем в окне Properties нажимаю имеющуюся там кнопку Property Pages. Затем в открывшемся окне свойств, показанном на рис. 2.3, устанавливается нужное свойство. В данном случае я задал имя файла отчета hello.xml.

Окно Property Pages проекта и задание имени XML-отчета

Рис. 2.3.  Окно Property Pages проекта и задание имени XML-отчета

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

<?xml version="1.0"?> <doc> <assembly> <name>ConsoleHello</name> </assembly> <members> <member name="T:ConsoleHello.Class1"> <summary> Первый консольный проект - Приветствие </summary> </member> <member name="M:ConsoleHello.Class1.Main"> <summary> Точка входа. Запрашивает имя и_выдает приветствие </summary> </member> </members> </doc>

Как видите, отчет описывает наш проект, точнее, сборку. Пользователь, пожелавший воспользоваться этой сборкой, из отчета поймет, что она содержит один класс, назначение которого указано в теге <summary>. Класс содержит лишь один элемент - точку входа Main с заданной спецификацией в теге <summary>.




Начало  Назад  Вперед