Java注释--单行注释、多行注释、文档注释
生活随笔
收集整理的這篇文章主要介紹了
Java注释--单行注释、多行注释、文档注释
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
Java注釋–單行注釋、多行注釋、文檔注釋
單行注釋和多行注釋
語法格式
//單行注釋 //單行注釋 //注釋內容/* 這里可以放置多行注釋 多行注釋的內容 Java真的學起來有意思!! */舉例:
//這是一段用于測試注釋的代碼 public class Annotation_test{public static void main(String[] args){//下面的語句將原封不動輸出:Hello Annotation!!System.out.println("Hello Annotation!!");} }編譯和執行:
可見,注釋不改變代碼的輸出
總結來說,注釋有以下這些作用:
(1)增強可讀性,注釋起到解釋說明的作用,不論是自己還是別人,看了注釋,都會更明確代碼的邏輯
(2)便于調試。發現有問題的代碼,可以直接注釋掉,便于排除代碼中的障礙
其實我本人最討厭什么注釋都不寫的代碼,寫注釋真的是一個非常良好的習慣!
文檔注釋
舉例:
/** @author bones @version 1.0 這是關于java基礎的文檔注釋的 代碼,非常好理解 */ public class Anno_test2{public static void main(String[] agrs){System.out.println("Hello 文檔注釋!!");}/**@param name 姓名@param age 年齡@param height 身高*/public boolean isPickSno(String name,int age,double height){if(age>0){return true;}else{return false;}} }文檔注釋的語法格式:
/** 文檔注釋的內容。。。。 */文檔注釋放在整個文件前面,可以說明作者、版本、日期、包名等信息,文檔注釋放在一個方法前面,可以說明形式參數等含義等。
同時文檔注釋可以配合javadoc.exe生成一套類似于關于這個自定義類的網頁API
例如:
查看需要點擊index.html文件:
跟Java的API很類似:
總結
以上是生活随笔為你收集整理的Java注释--单行注释、多行注释、文档注释的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Spring Boot -Shiro配置
- 下一篇: c# 写文件注意问题及用例展示