2011-01-12 49 views
3

我很好奇,如果Doxygen解析Javadoc評論? - 也就是說,它的doxygen接受的東西都這樣:Doxygen解析javadoc?

/** 
    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的風格的一個比較正確的做法?

回答

5

Doxygen接受與JavaDoc類似的語法,但不完全一樣。除了@ret命令外,您的示例註釋將被識別。 doxygen中的正確命令是@return

下面是doxygen的網站的例子:

http://www.stack.nl/~dimitri/doxygen/docblocks.html

+0

可愛的THX :) - 我需要什麼 – Skeen 2011-01-18 17:07:40