java API 部分注释格式

最新推荐文章于 2025-05-19 21:11:14 发布

原创最新推荐文章于 2025-05-19 21:11:14 发布 · 828 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #api #注释

本文介绍了一种Java API文档注释的格式规范，包括使用@param和@return进行参数和返回值说明的方法。为了确保生成的HTML文档清晰易读，文中还特别提到了如何正确地使用HTML标签来进行换行和分段。

java API 部分注释格式

@param 和@return 格式

由于生成的API文档为HTML，所以注释换行应用<br>,另起一新段落用<p>。

//account为ArrayList类实例
//account中元素类型为Account类型实例
/**
*方法的大概描述
*@param num 所要返回的account中元素的位置
*@return 返回指定位置的元素
*/
public Account getAccount(int num) {
		return account.get(num);
	}