Документирование с использованием XML файла

@Соколиный глаз · Регистрация: 25.07.2014

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

Читаю эту статью и возник ряд вопросов:
1) Зачем использовать

Code
1
<docs></docs>

? Это заранее зарезервированный тег?
2) Зачем использовать

Code
1
<members></members>

? Это заранее зарезервированный тег?

@V_Monomax · 18.10.2018, 16:14

Сообщение от Соколиный глаз

1) Зачем использовать

XML
1
<docs></docs>

Насколько я понимаю, этот тег используется в отдельном файле для документирования класса и его содержимого.

Сообщение от Соколиный глаз

Это заранее зарезервированный тег?

Да, но вы его можете переопределить, но лучше этого не делать.

Сообщение от Соколиный глаз

2) Зачем использовать

XML
1
<members></members>

Для того что-бы в отдельной части указать про какой класс/структуру идет речь.

Добавлено через 39 секунд
и да он зарезервирован для документации, но может быть переопределен.

@amr-now · 18.10.2018, 16:15

Соколиный глаз, неужели Вам больше нечего поизучать?

XML-документацию хоть применяете в программах? Или пока некогда было?
Штука полезная. Рекомендую. Мышкой на слове наведете, и появится всплывающая подсказка.

@kolorotur · 18.10.2018, 16:20

Сообщение от Соколиный глаз

Зачем использовать

Это же формат генерируемого файла с документацией — вам не надо эти теги использовать в коде вручную, они там нужны для того, чтобы среда разработки знала где искать документацию для типов.

@Соколиный глаз · 18.10.2018, 16:33 **[ТС]**

Сообщение от amr-now

XML-документацию хоть применяете в программах? Или пока некогда было?

Да, применяю.

Новые блоги и статьи Все статьи Все блоги /
SDL3 для Web (WebAssembly): Работа со звуком через SDL3_mixer 8Observer8 08.02.2026 Содержание блога Пошагово создадим проект для загрузки звукового файла и воспроизведения звука с помощью библиотеки SDL3_mixer. Звук будет воспроизводиться по клику мышки по холсту на Desktop и по. . .	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 была полностью переписана на Си, в. . .

Документирование с использованием XML файла

Решение

Решение

@amr-now 6496 / 3907 / 2006 Регистрация: 14.06.2018 Сообщений: 6,781
	18.10.2018, 16:15
	Соколиный глаз, неужели Вам больше нечего поизучать? XML-документацию хоть применяете в программах? Или пока некогда было? Штука полезная. Рекомендую. Мышкой на слове наведете, и появится всплывающая подсказка. 0