Java笔记003-Java转义字符、 注释(comment)、 Java代码规范

目录

Java转义字符

Java常用的转义字符

注释(comment)

介绍

Java中的注释类型

1．单行注释

2．多行注释

3．文档注释

单行注释

多行注释

文档注释

javadoc 输出什么

javadoc 标签

 Java代码规范

---

Java转义字符

Java常用的转义字符

在控制台,输入tab键，可以实现命令补全

1) \t :一个制表位,实现对齐的功能

2) \n :换行符

3) \\ :一个\

4) \” :一个"

5) \' :一个'

6) \r :一个回车 System.out.println("叱咤风云\r英雄");

说明
应用实例

//演示转义字符的使用
public class ChangeChar {
    //编写一个main方法
    public static void main(String[] args) {
//        1) \t :一个制表位,实现对齐的功能
        System.out.println("北京\t天津\t上海");
//        2) \n :换行符
        System.out.println("Jack\nSmith\nMary");
//        3) \\ :一个\
        System.out.println("E:\\java_study\\001-java_study\\study\\src");
//        4) \” :一个"
        System.out.println("子曰：\"君子食无求饱，居无求安，敏于事而慎于言，就有道而正焉，可谓好学也已。\"");
//        5) \' :一个'
        System.out.println("子曰：\'君子食无求饱，居无求安，敏于事而慎于言，就有道而正焉，可谓好学也已。\'");
//        6) \r :一个回车 System.out.println("叱咤风云\r英雄");
        System.out.println("叱咤风云\r英雄");
    }
}

注释(comment)

介绍

用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性(可读性);注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来，再用代码去体现。[举例]

Java中的注释类型

1．单行注释

2．多行注释

3．文档注释

单行注释

基本格式
格式：//注释文字

多行注释

基本格式
格式：/*注释文字*/

使用细节：

1)被注释的文字，不会被JVM (java虚拟机)解释执行

2)多行注释里面不允许有多行注释嵌套

文档注释

注释内容可以被JDK提供的工具javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档,一般写在类

基本格式

它以 /** 开始，以 */结束。说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。说明注释，使你更加方便的记录你的程序信息。

如何生成对应的文档注释

应用实例

javadoc 输出什么

javadoc 工具将你 Java 程序的源代码作为输入，输出一些包含你程序注释的HTML文件。

每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。

由于 javadoc 的实现不同，工作也可能不同，你需要检查你的 Java 开发系统的版本等细节，选择合适的 Javadoc 版本。

javadoc 标签

 Java代码规范

1．类、方法的注释，要以javadoc的方式来写。

2．非Java Doc的注释，往往是给代码的维护者看的，着重告述读者为什么这样写，如何修改，注意什么问题等

3．使用tab操作，实现缩进，默认整体向右边移动，时候用shift+tab整体向左移

4．运算符和 = 两边习惯性各加一个空格。比如：2 + 4 * 5 + 345 - 89

5．源文件使用utf-8编码

6．行宽度不要超过80字符

7．代码编写次行风格和行尾风格