Создание Windows-приложений на основе Visual C#



XML-документирование кода


При написании комментариев к коду приложения Calculator я использовал XML-комментарии. Для вставки XML-комментария достаточно трижды поставить знак слэша — ///, среда сама откроет тег, где уже можно вводить текст комментария. Использование такого способа документирования более удобно, чем обычное комментирование, — можно переносить слова на следующую строку без добавления знака комментария. Но самое главное — компилятор транслирует эти комментарии в отдельный XML-файл. Откройте окно Solution Explorer проекта Calculator и щелкните правой кнопкой на его названии. В появившемся контекстном меню выберите пункт Properties. На вкладке Configuration Properties/Build (см. рис. рис. 1.24) в поле XML Documentation File введите название выходного файла — CalcDescription.xml. Скомпилируйте приложение. Запустите проводник Windows (клавиша Windows+E) и перейдите в папку, содержащую проект Calculator. В ней появился созданный нами файл CalcDescription.xml, содержимое которого представляет собой обычный XML- документ:

<?xml version="1.0" ?> <doc> <assembly> <name>Calculator</name> </assembly> <members> <member name="F:Calculator.Calc.odin"> <summary>Объявляем и инициализируем переменные, которые будут возникать на экране при нажатии соответствующих кнопок.</summary> </member> <member name="M:Calculator.Calc.Dispose(System.Boolean)"> <summary>Clean up any resources being used.</summary> </member> <member name="M:Calculator.Calc.InitializeComponent"> <summary>Required method for Designer support — do not modify the contents of this method with the code editor.</summary> </member> <member name="M:Calculator.Calc.Main"> <summary>The main entry point for the application.</summary> </member> <member name="M:Calculator.Calc.btn1_Click(System.Object,System.EventArgs)"> <summary>Обработчики для кнопок обращаются к методу chislonaEkrane класса mehanizmcalkulyatora и передают ему одну из постоянных (odin, dva, tri и т.д.). Результат, возвращаемый методом, присваивается свойству Text текстового поля txtOutput.</summary> </member> <member name="M:Calculator.Calc.btn_delenie_Click(System.Object,System.EventArgs)"> <summary>Обработчики кнопок действия калькулятора передают методу DeystvieCalculatora класса mehanizmcalkulyatora переменную перечисления Deystvie.</summary> </member> <member name="F:Calculator.mehanizmcalkulyatora.peremennayaMinus"> <summary>Объявляем и инициализируем переменную, которая будет использоваться для смены знака при нажатии клавиши (+/–)</summary> </member> <member name="F:Calculator.mehanizmcalkulyatora.resultatVichisleniy"> <summary>Объвляем переменные для работы калькулятора: resultatVichisleniy — переменная для хранения промежуточного результата в механизме калькулятора; resultatOutput — переменная, значение которой будет сниматься с экрана и выводиться на него; tekusheeDeystvieCalculatora — хранение одного из действий калькулятора; pervoeChislo — переменная, в которую будет записываться число на экране до нажатия на одну из четырех кнопок с действием; vtoroeChislo — второе число на экране; dobavlenierazryada — при добавлении следующего разряда эта переменная примет значение true; ChislosTochkoy — при добавлении десятичного разряда (знака точки) эта переменная примет значение true</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.#ctor"> <summary>В конструкторе класса mehanizmcalkulyatora инициализируем переменные ChislosTochkoy и dobavlenierazryada — при запуске калькулятора на экране нет ни разрядности, ни десятичной части.</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.chislonaEkrane(System.String)"> <summary>В этом методе переменная resultatOutput изменяется — при вводе числа ее значение перезаписывается.</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.DeystvieCalculatora(Calculator.mehanizmcalkulyatora.Deystvie)"> <summary>Метод, в котором определяется peremenDeystviya, — одно значение перечисления Deystvie, в зависимости от выбора клавиши +, –, *, или /</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.ZnakChisla"> <summary>При нажатии кнопки +/–- число на экране — tekusheeChislo умножается на –1, а затем результат снова присваивается переменной resultatOutput.</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.ZnakTochki"> <summary>При нажатии кнопки ( , ) переменная resultatOutput приобретает дробную часть.</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.ZnakRavno"> <summary>При нажатии кнопки ZnakRavno обрабатываются значения переменнных pervoeChislo и vtoroeChislo, результат присваивается переменной resultatVichisleniy, которая затем преобразуется в resultatOutput.</summary> </member> <member name="M:Calculator.mehanizmcalkulyatora.Sbros"> <summary>При нажатии кнопки С (сброс) значения переменных обнуляются.</summary> </member> <member name="T:Calculator.mehanizmcalkulyatora.Deystvie"> <summary>Создаем перечисление Deystvie для определения одного из четырех действий калькулятора.</summary> </member> </members> </doc>




Содержание  Назад  Вперед