Способы документирования кода на c#

06.04.2011, 23:07. **Показов** 6529. **Ответов** 7

Студворк — интернет-сервис помощи студентам

Подскажите, пожалуйста, чайнику, какие способы документирования кода на c# сущетсвуют? Отлично, если вы знаете, как их использовать. Буду рада помощи. Заранее спасибо.

@Петррр · 06.04.2011, 23:13

Герберт Шилдт Полный справочник по C#. Там есть глава посвященная коментариям в стиле XML. А вообще перед методом или констурктором ставишь /// (три слеша), VS тебе автоматом сформирует XML в котором тебе нужно будет описать параметры.

Добавлено через 1 минуту
см. также msdn

@silicium · 30.03.2012, 11:03

Штука достаточно удобная, когда твой код будет использоваться в среде VS. В моём случае это не так. Но как из полученного XML файла получить полноценную документацию (лучше всего в формате того-ж MSDN) ?

@turbanoff · 30.03.2012, 11:31

Сообщение от silicium

Но как из полученного XML файла получить полноценную документацию (лучше всего в формате того-ж MSDN) ?

http://sandcastle.codeplex.com/

@silicium · 30.03.2012, 15:01

Сейчас пользуюсь doxyGen. В принципе, терпимо
А Microsoft ничего не предлагает?
Хотелось бы получить что-то на подобии MSDN всё-таки

@turbanoff · 30.03.2012, 15:21

Сообщение от silicium

А Microsoft ничего не предлагает?

sandcastle и предлагает. http://blogs.msdn.com/b/sandcastle/

@silicium · 30.03.2012, 23:18

Реально. Спасибо, протупил

@silicium · 05.04.2012, 17:08

Собственно, сапожник оказался без сапог: нормальной документации кот наплакал.
Кто-нибудь пользовался этим инструментом? Может по шагам рассказать?

А то как то doxyGen странно использовать в Microsoft продуктах. Да и вёрстка у него по мелочи, но съезжает. И теги чуть-чуть, но разные...

Новые блоги и статьи Все статьи Все блоги /
SDL3 для Web (WebAssembly): Основы отладки веб-приложений на SDL3 по USB и Wi-Fi, запущенных в браузере мобильных устройств 8Observer8 07.02.2026 Содержание блога Браузер Chrome имеет средства для отладки мобильных веб-приложений по USB. В этой пошаговой инструкции ограничимся работой с консолью. Вывод в консоль - это часть процесса. . .	SDL3 для Web (WebAssembly): Обработчик клика мыши в браузере ПК и касания экрана в браузере на мобильном устройстве 8Observer8 02.02.2026 Содержание блога Для начала пошагово создадим рабочий пример для подготовки к экспериментам в браузере ПК и в браузере мобильного устройства. Потом напишем обработчик клика мыши и обработчик. . .	Философия технологии iceja 01.02.2026 На мой взгляд у человека в технических проектах остается роль генерального директора. Все остальное нейронки делают уже лучше человека. Они не могут нести предпринимательские риски, не могут. . .	SDL3 для Web (WebAssembly): Вывод текста со шрифтом TTF с помощью SDL3_ttf 8Observer8 01.02.2026 Содержание блога В этой пошаговой инструкции создадим с нуля веб-приложение, которое выводит текст в окне браузера. Запустим на Android на локальном сервере. Загрузим Release на бесплатный. . .
SDL3 для Web (WebAssembly): Сборка C/C++ проекта из консоли 8Observer8 30.01.2026 Содержание блога Если вы откроете примеры для начинающих на официальном репозитории SDL3 в папке: examples, то вы увидите, что все примеры используют следующие четыре обязательные функции, а. . .	SDL3 для Web (WebAssembly): Установка Emscripten SDK (emsdk) и CMake для сборки C и C++ приложений в Wasm 8Observer8 30.01.2026 Содержание блога Для того чтобы скачать Emscripten SDK (emsdk) необходимо сначало скачать и уставить Git: Install for Windows. Следуйте стандартной процедуре установки Git через установщик. . . .	SDL3 для Android: Подключение Box2D v3, физика и отрисовка коллайдеров 8Observer8 29.01.2026 Содержание блога Box2D - это библиотека для 2D физики для анимаций и игр. С её помощью можно определять были ли коллизии между конкретными объектами. Версия v3 была полностью переписана на Си, в. . .	Инструменты COM: Сохранение данный из VARIANT в файл и загрузка из файла в VARIANT bedvit 28.01.2026 Сохранение базовых типов COM и массивов (одномерных или двухмерных) любой вложенности (деревья) в файл, с возможностью выбора алгоритмов сжатия и шифрования. Часть библиотеки BedvitCOM Использованы. . .

enzowa

	Способы документирования кода на c# 06.04.2011, 23:07. Показов 6529. Ответов 7 Метки нет (Все метки) Подскажите, пожалуйста, чайнику, какие способы документирования кода на c# сущетсвуют? Отлично, если вы знаете, как их использовать. Буду рада помощи. Заранее спасибо.

@Петррр 6721 / 3570 / 900 Регистрация: 28.10.2010 Сообщений: 5,937
	06.04.2011, 23:13
	Герберт Шилдт Полный справочник по C#. Там есть глава посвященная коментариям в стиле XML. А вообще перед методом или констурктором ставишь /// (три слеша), VS тебе автоматом сформирует XML в котором тебе нужно будет описать параметры. Добавлено через 1 минуту см. также msdn 2

@silicium 5 / 5 / 1 Регистрация: 26.10.2010 Сообщений: 126
	30.03.2012, 11:03
	Штука достаточно удобная, когда твой код будет использоваться в среде VS. В моём случае это не так. Но как из полученного XML файла получить полноценную документацию (лучше всего в формате того-ж MSDN) ? 0

@silicium 5 / 5 / 1 Регистрация: 26.10.2010 Сообщений: 126
	30.03.2012, 15:01
	Сейчас пользуюсь doxyGen. В принципе, терпимо А Microsoft ничего не предлагает? Хотелось бы получить что-то на подобии MSDN всё-таки 0

@silicium 5 / 5 / 1 Регистрация: 26.10.2010 Сообщений: 126
	30.03.2012, 23:18
	Реально. Спасибо, протупил 0

@silicium 5 / 5 / 1 Регистрация: 26.10.2010 Сообщений: 126
	05.04.2012, 17:08
	Собственно, сапожник оказался без сапог: нормальной документации кот наплакал. Кто-нибудь пользовался этим инструментом? Может по шагам рассказать? А то как то doxyGen странно использовать в Microsoft продуктах. Да и вёрстка у него по мелочи, но съезжает. И теги чуть-чуть, но разные... 0