注释与规范

给代码写说明书！

📖知识引入

💬单行注释

//后面的内容到行尾都被忽略，像跟自己悄悄话

📜多行注释

/* */包围的多行内容，适合写段落说明

📚Javadoc注释

/** */专门给工具生成API文档用，是Java独门秘籍

🐫驼峰命名

类名大驼峰HelloWorld，变量方法小驼峰userName

📋代码规范

一行只写一条语句，缩进4空格，命名见名知义

💡

好的注释解释"为什么"而不是"做什么"，代码本身应能说明做什么

🔍注释的三种写法

/**
 * 程序入口
 * @author Monkey
 */
public class Note {
    public static void main(String[] args) {
        // 打印问候
        System.out.println("Hi");
        /* 多行
           说明 */
        System.out.println("Bye");
    }
}

Java注释类型对照：
┌────────┬──────────┬──────────┐
│ 类型   │ 写法     │ 用途     │
├────────┼──────────┼──────────┤
│ 单行   │ //       │ 简短说明 │
│ 多行   │ /* */    │ 段落说明 │
│ 文档   │ /** */   │ 生成API  │
└────────┴──────────┴──────────┘

编译器会忽略注释内容，但读代码的人会感谢你写的每一条

🎯小测验

第1题：单行注释用什么符号？

第2题：类名HelloWorld是什么命名法？

第3题：哪种注释能被Javadoc工具识别？

📝本课知识点

✓//单行注释
✓/* */多行注释
✓/** */文档注释
✓驼峰命名法
✓代码要见名知义

第3课完成！继续探索下一课吧 🚀

☕

上一课

第2课

下一课

第4课

☕