news 2026/6/13 15:37:25

java入门笔记(九)编写规范其二

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
java入门笔记(九)编写规范其二

P2-8-3:规范约束第三讲

C语言时期就陪着我们的规范:

关于字符数量的规范,也是我们以后用链式调用时会用到的规范,用这种垂直换行的方式来避免单行字符数超过120个

方法参数的规范:

关于编译器的字符编码格式的规范:

编写方法的规范:

然后继续看控制语句的编写规范,先看一下switch的规范

注意标蓝的部分,很重要,不要搞混break是退出语句块, 而return是直接退出整个方法

我们C语言里学过,if条件判断或者是 循环里面的代码内容只有一行的话,可以把花括号省略掉,

但是在Java中这样是绝对不行的!必须要带上花括号!

说明里给的内容就是用来警戒的错误案例,在Java里绝对不可以这么写,必须要加上花括号

尽量避免使用 ! 这个取反逻辑运算符,因为这样会让代码可读性降低,变得特别绕,就像该死的双层嵌套循环一样

第七章目前能讲的只有这么多,现在讲第八章 注释规约

里面说的Javadoc 规范其实就是 我们之前学的类注释

我们给类,类属性,类方法写注释时一定要用 类注释 /** */

不要用行注释// 或者是 段落注释 /* */ !!! 这样是不符合规格的!

错误案例:

正确案例:

类方法的模板:

第3条准确来说是在类注释里,必须添加创建者和创建日期

第4条规范很重要:

错误案例:

正确案例:

有关注释内容的规范:

这一条是对使用git的程序员的注释规范, git本身就是一个仓库,会保存你的历史代码,

所以如果你有git的话,那么就要遵循这条规范

毕竟git都直接给我们保存的历史代码了,那么我们在开发中发现这段注释掉的代码没用了就可以果断删掉,反正就算删掉了git里保存的历史版本里也还有备份

在企业开发中git肯定大家都用,所以你就必须要遵守这条规范,即不要随便把代码注释掉,

如果注释了那一定要在上面把注释的原因说出来如果这段代码已经确定没用了,那就不用注释了,直接删掉就行

写注释以及命名的宝贵经验:

使用案例:

可以看到, TODO 和 FIXME 这两个注释很特殊,它们写出来后会被编译器自动标上蓝色波浪线,

来提醒我们程序中有未完成 以及 需要修复的地方

并且在下方界面的“问题”一项中也会显示我们注释的TODO和FIXME,还会告诉你具体的位置

目前我们手册里能讲的只有这些,剩下的内容等我们把Java的内容学好之后再说

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/6/13 15:36:23

高效AI教材写作攻略:低查重AI工具助力,3天完成20万字教材编写!

整理教材中的关键知识点真是一项“精细活”,最大的挑战在于如何平衡和衔接这些知识!我们总是担心忽略了那些核心内容,或者在掌控难易程度时把握不好——小学教材往往让学生觉得深奥难懂;而高中教材则可能过于简单,缺乏…

作者头像 李华
网站建设 2026/6/13 15:36:19

抖音下载器终极指南:5步构建专业级视频采集系统

抖音下载器终极指南:5步构建专业级视频采集系统 【免费下载链接】douyin-downloader A practical Douyin downloader for both single-item and profile batch downloads, with progress display, retries, SQLite deduplication, and browser fallback support. 抖…

作者头像 李华
网站建设 2026/6/13 15:26:51

终极指南:如何解决QuPath命令行模式下OpenSlide扩展加载失败问题

终极指南:如何解决QuPath命令行模式下OpenSlide扩展加载失败问题 【免费下载链接】qupath QuPath - Open-source bioimage analysis for research 项目地址: https://gitcode.com/gh_mirrors/qu/qupath 你是否遇到过这样的困扰?在QuPath图形界面中…

作者头像 李华
网站建设 2026/6/13 15:20:51

深入解析MCF51AC256中心对齐PWM:原理、配置与降噪实战

1. 项目概述与核心价值在嵌入式开发,尤其是涉及电机控制、开关电源或者需要精确模拟信号生成的领域,PWM(脉冲宽度调制)是工程师手中最基础也最强大的工具之一。但你是否遇到过这样的困扰:明明PWM波形频率和占空比都算对…

作者头像 李华