java优雅注释原则和代码格式列举
一、java的三种注释类型
- 单行注释:// ......
- 块注释:/* ...... */
- 文档注释:/** ...... */
二、指导原则
- 注释不能美化糟糕的代码,碰到糟糕的代码就重新写吧。
- 用代码来阐述你的意图,好的代码就是最好的注释。
- 错误的注释比不注释更可怕。
- 大括号后不要加注释,建议另起一行。
- 注释调的代码建议删掉。
- 废话式注释,循规式注释,误导性注释都应该删掉。
- 巧用标记(TODO、FIXME)
- 注释要放在距离其描述代码最近的位置。
三、代码格式列举
这里和大家聊下代码基本格式,好的代码格式会让维护者更容易阅读和理解。
package effective.code.up;
/**
*
* <p>Description: 这里写出这个类的描述,新写的类一定要带上日期和作者</p>
* @author wudiffs
* @date 2019年5月7日
*/
public class EffectiveCodeFormat {
public static void main(String[] args) {
// 缩进4个空格
String say = "hello";
// 运算符左右必须有一个空格
int flag = 0;
// 关键词if与括号之间必须有一个空格,括号内的f与左括号,0与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左大括号前加空格且不换行,左大括号后换行
if (flag == 1) {
System.out.println("world");
// 右大括号前换行,右大括号有else,不用换行
} else {
System.out.println("ok");
// 在右大括号直接结束,则必须换行
}
/*当行字符数限制不超过120个字符,超出需换行,换行遵循如下原则:
* 1.第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进
* 2.运算符与上下文一起换行
* 3.方法调用的点符号与下文一起换行
* 4.方法调用多个参数,需要换行时,在逗号后进行
* 5.括号前不要换行
*/
StringBuffer sb = new StringBuffer();
sb.append("AA").append("AA").append("AA").append("AA").append("AA").append("AA").append("AA").append("AA")
.append("BB").append("BB").append("BB").append("BB").append("BB").append("BB").append("BB").append("BB")
.append("BB").append("BB").append("BB").append("BB");
// 不同逻辑,不同语义,不同业务的代码之间插入一个空行分隔开来以提升可读性。
System.out.println("six six six up up up");
}
/**
* 方法参数在定义和传入时,多个参数逗号后边必须加空格。方法描述要加上。
* @param sa
* @param sb
* @param sc
*/
public static void doSomething(String sa, String sb, String sc) {}
}
java优雅注释原则和代码格式列举的更多相关文章
- 《阿里巴巴Java开发手册》代码格式部分应用——idea中checkstyle的使用教程
<阿里巴巴Java开发手册>代码格式部分应用--idea中checkstyle的使用教程 1.<阿里巴巴Java开发手册> 这是阿里巴巴工程师送给各位软件工程师的宝典,就像开车 ...
- java开发规范总结_代码注释规范
规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了.如果注释太复杂说明程序需要修改调 ...
- Eclipse中更改默认java代码格式【转】
在写代码时常常有2种代码样式习惯,如下图.由于一直习惯了第一种代码格式,而看第二种代码格式时感觉代码很乱,总找不到“{ }”对称的感觉.Eclipse自动格式化代码的快捷方式是Ctrl+Shift+F ...
- 列举两种不同类型的Java标识注释,并解释它们之间的区别。
列举两种不同类型的Java标识注释,并解释它们之间的区别.
- 关于Java开发过程中质量提升-1代码格式配置
在项目开发维护中,编码规范作为开发规范的一个组成部分,是十分重要和必须的,它不仅仅是为了提高开发效率,也有利于降低后期维护开发的成本.编码规范的根本目的就是要让不仅代码可以一目了然,也可以很容易的理解 ...
- 【JAVA 学习笔记1】代码注释
在JAVA中支持单行注释和多行注释 1.单行注释,只要在注释的一行代码中加上双斜杠即可 例如: // int a=2,b=4,c=8; 2.多行注释,在开始位置加上/* 结束位置加上*/ 例如 /* ...
- Java代码格式
东汉大臣陈蕃有一则这种故事,"一屋不扫何以扫天下",寓意来表明一个大丈夫,假设连自己的居室都不能打扫干净,怎么胸怀天下.<代码整洁之道>就是来劝诫我们程序猿写出更优秀的 ...
- 《码处高效:Java开发手册》之代码风格
流水淡,碧天长,鸿雁成行.编码风格,简捷清爽,反引无限风光. 在美剧<硅谷>中有这样一个经典镜头,主人公 Richard 与同为开发工程师的女友闹分手,理由是两人对缩进方式有着截然不同的编 ...
- java基础-注释
注释是一种形式的元数据,提供了非程序自身的数据,注释对于被注释的代码没有直接的影响. 本文主要概括注释的使用,java平台(SE)预定义的注释,类型注释是如跟可插入类型系统连用达到更强的类型检查的,以 ...
随机推荐
- http接口测试和使用,首先要了解什么是http请求
http接口测试和使用,首先要了解什么是http请求: http请求通俗讲就是把客户端的东西通过http协议发送到服务端,服务端根据http协议的定义解析客户端发过 来的东西! http请求中常用到的 ...
- KVM :vnc 远程控制kvm创建虚拟机
一.vnc远程控制服务器 前期准备: 1.编辑/etc/hosts vi /etc/hosts 10.1.16.32 kvm 2.关闭防火墙 service iptables stop 3.关闭sel ...
- NET Core CSharp初级篇 1-3面向对象
.NET Core CSharp初级篇 1-3 本节内容为面向对象初级教程 类 简介 面向对象是整个C#中最核心最有特色的一个模块了,它很好的诠释了程序与现实世界的联系. 面向对象的三大特征:继承.多 ...
- win10修改桌面图标之间的距离
操作方法01首先用Win+R组合键打开运行界面,在界面的输入框中输入regedit命令,打开注册表. 02在打开的注册表界面中我们找到HKEY_Current_User下的Control Panel文 ...
- AT649 自由研究
这道题有些水... 我们观察到,这是一道彻底离线的题目,连输入也没有,我们可以发现1<=n<=401<=n<=401<=n<=40 于是,我们就可以考虑n=1n=1 ...
- Python开发:NumPy学习(一)ndarray数组
一.数据维度 一个数据表达一个含义,一组数据表达一个或多个含义. 数据维度概念:一组数据的组织形式,其中有一维数据.二维数据.多维数据.高维数据. 1. 一维数据 一维数据由对等关系的有序或无序数据 ...
- idea导入ssm javaweb maven项目
本文笔者辛苦整理, 除了为方便大家贴的maven安装配置和方便的现有项目, 如转载请注明: https://www.cnblogs.com/m-yb/p/11229320.html idea导入ssm ...
- Java编程基础阶段笔记 day01 Java语言概述
目录内容 DOS命令 电脑配置 Java语言的特性 Java两种核心机制 Java语言环境搭建 第一个Java程序 注释 Java语句说明 编程风格 作业 常用的DOS命令 dir : 列出当 ...
- codemirror使用
JS使用 使用bower下载 bower i codemirror 引入样式文件 <link rel="stylesheet" type="text/css&quo ...
- Linux中tree无法正常显示中文的解决方法
tree命令以树状图列出目录的内容. 命令 tree -L n 的时候往往是无法正常显示中文的 先开始我以为是tree命令对中文是不支持的,后来百度了一下,网上有几个解决办法 安装新的tree可以解决 ...