多行注釋與文檔注釋的區別: 多行注釋的內容不能用於生成一個開發者文檔,
而文檔注釋 的內容可以生產一個開發者文檔。
使用javadoc開發工具即可生成一個開發者文檔。
javadoc工具的使用格式:
javadoc -d 存放文檔的路徑 java的源文件
使用javadoc工具要注意細節:
1. 如果一個類需要使用javadoc工具生成一個軟件的開發者文檔,那么該類必須使用public修飾。
2. 文檔注釋注釋的內容一般都是位於類或者方法的上面的。
寫注釋的規范:一般單行注釋是位於代碼的右側,多行注釋與文檔注釋一般是寫在類或者方法的上面的。