Java 注释,代码规范【入门4】

举报
光之梦 发表于 2023/10/28 19:40:12 2023/10/28
【摘要】 我的目标是:用通俗易懂的口语来为大家讲解 Java 的每一个语法知识,让零基础小白也能看懂,并且全部学会并能够熟练运用。

我的个人主页光之梦的博客_云社区-华为云 (huaweicloud.com)

欢迎各位 👍点赞 ⭐收藏 📝评论,如有错误请留言指正,我会第一时间改正。非常感谢!

特别标注本博主将会长期更新c语言的语法知识,初学c语言的朋友们,可以收藏订阅一下我的<C语言基础语法>专栏。关注博主,学习不迷路哦

 一、注释

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


1、单行注释 //

格式: //注释文字


2、多行注释 /* */

格式: /* 注释文字 */


3、文档注释 /** */

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

基本格式:

/**
* @author 光之梦
* @version 1.0
*/
​
public class wendangzhushi{
    public static void main(String[] args){
        ……
    }
}

如何生成对应的文档注释

在控制台中输入:javadoc -d 文件夹名 -xx -yy Demo3.java

-d 代表我要把生成的文档放到那个目录里面

-xx,-yy 指的是你这里用到了那些javadoc标签,你要生成那些对应的 Javadoc 标签

如:author,version这两个就是Javadoc标签

Demo3.java 就是你要编译的 java 文件


那么,也就是在控制台中输入:javadoc -d d:\\temp -author -version Demo3.java

最后按一下回车

注:javadoc标签 可以写很多个。我们最好是把文档注释要生成的文件放到d盘下的下一级文件夹中,不然可 能由于文件夹没有源代码从而编译不了。文档注释用的非常多,一定要学会


使用细节:

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

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


不管是变量的命名还是运算符的计算,中间最好都要用空格隔开

int ni = 1 + 2;
int n2 = 5 + 10;
int n3 = 1 + 3 * 34;

等号之间两边来一个空格,运算符两边也来空格

这样是一种比较好的编程方式。这样写会让人看起来很舒服,没那么紧凑


选中,然后输入 tab 整体右移

选中,然后输入 shift+tab 整体左移



二、java 代码规范

1、类、方法的注释,要以 javadoc 的方式来写。(文档注释)

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

3、使用tab操作,实现缩进,默认整体向右边移动,用shift+tab整体向左移

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

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

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

7、代码编写次行风格和行尾风格(!!),推荐使用行尾风格(java作者用的就是行尾风格)



1、DOS命令(了解)

了解就行

DOS介绍:Disk Operating System 磁盘操作系统,简单说一下windows的目录行:Dos目录结构


DOS的基本原理:

当我们在这个控制台输入 md 或者 rd 时,我们一回车就会把这个指令,发送给dos系统,最终是作用在你所在的盘符中。也就是说:在我们这个黑乎乎的控制台,我们输入了一条指令,交给真正的dos系统,dos系统进行接受解释,然后最终对我们的Windows系统进行了一个相应的操作,这就是它的基本原理



2、相对路径, 绝对路径(重要)


相对路径:从当前目录开始定位,形成一个路径

需求:从 adc\test100 访问 hello.txt

..\ 就是到上级目录

在test100的这个目录下,我们要去访问hello.txt,先..\到abc,再..\到abc2,最后再到 hello.txt

也就是说我们是从 test100 当前文件开始一层一层的找到,这个就叫相对路径


绝对路径:就是从顶级目录D盘开始

如果在顶级目录用 ..\ ,它不动,也不会报错。用cd .. 它也不会报错


常用的 dos 命令(了解)

  1. 查看当前目录是有什么内容 dir

    dir dir d:\abc2\test20
  2. 切换到其他盘下:盘符号 cd

    案例演示:切换到 c盘 cd /D c:

  3. 切换到当前盘的其他目录下(使用相对路径和绝对路径演示)

    案例演示:

    cd d: abc2 test200 cd ....abc2 test200

  4. 切换到上一级:案例演示:cd

  5. 切换到根目录: cd \

  6. 查看指定的目录下所有的子级目录 tree

  7. 清屏 cls 【要清屏就找苍老师】

  8. 退出 DOS exit

  9. 说明: 因为小伙伴后面使用 DOS 非常少,所以对下面的几个指令,大家了解即可

    md[创建目 录],rd[删除目录],copy[拷贝文件],del[删除文件],echo[输入内容到文件]type,move[剪切]

我们对这些指令的使用应该是非常少,所以你只需了解一下大体就行,知道他是干什么的就行。搞清楚这个相对路径和绝对路径就行,其他的指令做一个基本的了解,因为这些指令在今后你是绝对不会用的,在Linux下才会使用,而到了Linux这些指令它的用法都发生变化了。虽然我们极少用,但是了解一下还是必要的



三、java 编写步骤

1、编写 java 源代码

2、javac 编译 ,得到对应的 .class 字节码文件

3、java 运行 ,本质就是:把 .class 文件加载到 jvm 中运行




欢乐的时光总是过得快,又到时间说拜拜了

如果有问题随时都可以来问我,我会随时为您解答!欢迎大家与我一起学习,互相进步。

创作不易,👍 +⭐ +📝(一键三连) 是对博主最大的鼓励与支持哦。

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。