如何在我的项目中使用我的文档注释,如android文档?

时间:2012-01-03 04:23:56

标签: java android eclipse documentation

我为项目的源代码构建了文档注释作为库。以及如何在使用该库的新项目中使用它们像android文档一样?

3 个答案:

答案 0 :(得分:2)

根据我的理解,我认为你可以这样做

无论你想在哪里记录某些东西,都要保留在methode,变量或任何类之上。每当你下次将鼠标移动到该方法或变量或类时,你就会得到它像文档一样。

/**
* getDocument() method gives you 
* @parameter String USerID
* @return String 
*/
public String Document(int UserID) throws Exception
{
return documentString;
}

这里的甲酸盐部分你必须写下所有东西。如上所述@parameter,@return等。

答案 1 :(得分:1)

我猜您正在寻找javadoc,它会根据您的评论生成HTML文档页面(如果您的评论遵循javadoc格式)。这是关于Javadoc

的链接

答案 2 :(得分:1)

我想你要找的是从Eclipse中的javadoc注释生成HTML的方式,这篇文章可能包含答案:http://dtmilano.blogspot.com/2010/02/android-generate-javadoc-for-your.html