當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

文档注释规范

發(fā)布時間：2025/3/18 编程问答 22 豆豆

生活随笔收集整理的這篇文章主要介紹了文档注释规范小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

2019獨角獸企業(yè)重金招聘Python工程師標準>>>

我們功能一般是分包開發(fā)的，在包下創(chuàng)建一個package.html，在包里簡要描述本包的功能。模板：

<html> <body> package description </body> </html>

可以用較長的文字說明該類是的功能，最好的方式是其他人只讀類描述就能知道這個類是做什么的，應該有什么樣的方法。基本模板：

<h1>標題</h1> <p>主要內(nèi)容進行<strong>強調(diào)</strong>，更多信息查看{@link Object}</p>

在eclipse中設置創(chuàng)建類時的模板在eclipse菜單

Window -> Preferences -> Java -> Code Style –> Code Templates

中，選擇Comments中的Types，編輯

<p>Copyright (c).</p> @author author @since @version

方法描述要說明方法做了什么，有什么影響，使用時有什么要注意的；可以不用說具體怎么做。 @param @return @throws都要進行說明

簡要說明成員變量的意義。

/*** field description*/ private String field

轉載于:https://my.oschina.net/geekidentity/blog/1604751

以上是生活随笔為你收集整理的文档注释规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。