Документирование ТОЛЬКО определенного кода и игнорирование всех остальных?

Question

В настоящее время я использую doxygen в проекте C #, но если эту функцию можно найти в другом генераторе документации, работающем с C #, тогда я заинтересован.

Я хочу, чтобы генератор документации игнорировал все комментариии код, кроме тех, у кого есть определенные ключевые слова комментариевМне нужна функциональность, противоположная ключевым словам doxygen \cond и endcond.Например, что-то вроде:

///
/// This comment and variable declaration is ignored by the documentation
/// generator.
///
public double MySecretPublicVar;

/// /doc-this
/// This comment and variable declaration is documented by the documentation
/// generator.
/// /doc-this-end
public double MyDocumentedVar;

Answer 1

Наиболее близким соответствием желаемой функциональности является команда @ internal .Он по-прежнему работает в обратном направлении к тому, что вы хотите, но может быть удобнее, чем заключать все в условные блоки.Вам нужно позаботиться о том, чтобы @internal было первым в блоке документации.

Кроме того, вам, вероятно, потребуется установить настройки HIDE_UNDOC_MEMBERS и HIDE_UNDOC_CLASSES, чтобы действительно удалить MySecretPublicVar издокументация (потому что если задано значение Internal, оно удаляет только документацию).И убедитесь, что для EXTRACT_ALL установлено значение false.

И даже в этом случае вам, вероятно, нужно позаботиться о том, чтобы вещи, которые вы хотите получить внутри, случайно не проскользнули.Так что да, doxygen не совсем подходит / не подходит для вашего случая использования или, по крайней мере, требует немного усилий для этого.

Answer 2

Инструмент

VSdocman (я работаю в компании, которая его производит) может сделать это гибко с фильтрами регулярных выражений .В вашем случае вы просто указываете «включить» фильтр для подписи с комментариями XML.Если вы хотите сопоставить любое из «key_word1» или «key_word2» в нем, используйте регулярное выражение, например: . * My_keyword1 | my_keyword2. *