Я прочитал повсюду , что Doxygen - это путь для генерации Документация для C # код. У меня есть один интерфейс, который я хочу задокументировать сначала (детские шаги), и у него уже есть комментарии XML (///).
Из-за огромного количества постов и информации доступной (включая doxygen.org), которые говорят, что эти комментарии уже поддерживаются, я удивлен, что когда я запускаю DoxyWizard, я получаю ошибки, как «Предупреждение: Компания :: Product: : MyInterface не задокументировано ».
Это приводит меня к вещению, что у меня есть как-то неправильно понял документацию XML (надеюсь, нет, согласно MSDN Я говорю о правильной вещи), или у меня неправильно повернут doxywizard.
Я сначала запустил DoxyWizard через вкладку Wizard и уточнил, что хочу поддержать C # / Java. Когда я бегу, моя HTML-страница пуста, предположительно из-за ранее упомянутых предупреждений. Затем я попробовал указывать один файл через вкладку Expert и снова бегал - одинаковое поведение.
Кто-нибудь может сказать мне, какой коммутатор или настройка мне не хватает, чтобы получить Doxygen, чтобы генерировать HTML?
Вот пример того, как в моем интерфейсе выглядит документированный свойство / метод:
///
/// Retrieve the version of the device
///
String Version { get; }
///
/// Does something cool or really cool
///
/// 0 = something cool, 1 = something really cool
void DoSomething( Int32 thing);
У меня есть комментарий:
///
/// Retrieve the version of the device
///
String Version { get; }
///
/// Does something cool or really cool
///
/// 0 = something cool, 1 = something really cool
void DoSomething( Int32 thing);
У меня есть комментарий Над интерфейсом, как это:
///
/// MyInterface
///
public interface MyInterface {...}