Показать часть тела метода в документации - PullRequest
Новая
       36

Показать часть тела метода в документации

0 голосов
/ 10 апреля 2019

Я хочу показать часть тела метода в его документации (JavaDoc).

Например: 

/**
 * The algorithm contains steps:
 * @showMethodBody
 */
public void algorithmX(int coordinateX) {
    makeStep1();
    if (coordinateX == TOP) {
        makeStep2();
    }
}

Который должен выдавать документацию вроде: 

    The algorithm contains steps:
    makeStep1();
    if (coordinateX == TOP) {
        makeStep2();
    }

Я знаю, что такая документация немного глупа и не на естественном языке.Но лучше всего то, что он никогда не устареет.

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

Вопрос:

Как скопировать (показать) часть или все тело метода внутри документации метода?

Теперь я 'Я использую JavaDoc, но я также могу использовать любой другой инструмент.Я также могу добавить несколько указателей (аннотации или специальные комментарии) в исходный код, если это поможет.

1 Ответ

1 голос
/ 10 апреля 2019

В Doxygen есть несколько возможностей:

  • INLINE_SOURCES, недостатком здесь является то, что для всех функций будет включен весь код
  • команды dontinclude вместе с \skip, \line и т. Д. Включают части файла.
  • \snippet команда, где можно пометить определенные части кода и разместить их в документации

См. Также руководство по doxygen по адресу http://www.doxygen.nl/manual/, в этом случае главы «Специальные команды» и «Конфигурация»

...