Анализ кислорода - PullRequest
       38

Анализ кислорода

3 голосов
/ 12 января 2011

Мне любопытно, будет ли Doxygen анализировать комментарии Javadoc?- то есть, принимает ли doxygen что-то подобное:

/**
   Greet with a "Hello" message.
   @param a string containing the name of the person or entity
   @ret return a string containing "Hello" and the name of the greeted person or entity.
*/
public String sayHello(string name)
{
   return "Hello" + name;
}

И еще, есть ли более правильный способ сделать эти комментарии, стиль doxygen?

1 Ответ

5 голосов
/ 14 января 2011

Doxygen принимает синтаксис, аналогичный JavaDoc, но не совсем такой же. Ваш пример комментария будет распознан, за исключением команды @ret. Правильная команда в doxygen - @return.

Вот примеры на сайте doxygen:

http://www.doxygen.nl/manual/docblocks.html

...