Java03-命名规范/ 注释/ 排版(换行、空格)
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了Java03-命名规范/ 注释/ 排版(换行、空格)，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含2261字，纯文字阅读大概需要4分钟。
内容图文
1. 命名规范
名字一般是两个单词的组合
驼峰命名：
大驼峰 vs 小驼峰
大驼峰：两个单词首字母大写，如ClassRoom
小驼峰：仅第二个单词首字母大写，如classRoom
包名、类名、接口名、变量、常量均使用大驼峰
2. 注释
2.1 //单行注释，快捷键：ctrl + / 或 Ctrl + shift + C，相同操作取消注释
2.2 /* … */多行注释，快捷键：ctrl + shift + /，ctrl + shift + \是取消多行注释
2.3 /**…*/ 文档注释，快捷键 Alt + shift + J：
2.3.1 如何修改出现的内容？，感觉只有author太单调
方法链接点此：
应用再关闭，改成这样后，再Alt + shift + J：
修改成功
2.3.2 常用的文件注释标签
| @author | 作者 |
| @deprecated | 该类、接口或成员已经无效 |
| @param | 参数 |
| @return | 返回值 |
| @see | 另一主题的连接 |
| @exception/@throws | 异常类 |
| @version | 版本 |
2.3.3 用javadoc生成文件注释
语法格式：javadoc -d 文件名 程序名.java
文件名就是生成的文档所在的文件的名字，该文件是新建的。
具体步骤：
进入程序文件所在的文件
在红框处填入cmd，enter后：
填入：javadoc -d asd HelloWorld.java
应该是成功运行，打开程序文件夹：
多了一个asd的文件夹，进入之：
进入 index.html，就可以看到：
点击 HelloWorld：
2.4 地标注释
TODO：此处代码未完成
FIXME：此处代码是错的，要修改
XXX：此处代码功能可实现，但可以继续改进
a(){
//TODO 输出参数
}
b(){
//FIXME 循环有问题
}
c(){
//XXX 排序可用快速排序
}
3. 排版
3.1 空行：有时一行代码太长需要换行
要注意
遇到逗号‘，’，在其后换行
遇到运算的符号什么的，在其前面换行
即逗号在上一行，符号在下一行（这样有助于看代码，可读性较好）
a(int timeday, int daystyle,
int flag, int local
){}
int longName1 = longName2 * (longName3
+ longName4) + 4;
boolName1 = (longName3 == longName4)
? (longName3 > longName4)
: (longName2 > longName5)
3.2 空格
a. =前后可空格
b. + - * / 等二元运算前后有空格
c. {} 的 '{'前面有空格
d. 运算时的 () 的 '('的后面无空格，‘)‘的前面无空格
e. 函数参数列表的 ()在d的基础之上：’('前面也无空格，逗号之后应有一个空格
f. ++等一元操作符前后和中间不可有空格
int a = 2; //a
int b = 2 + c; //b
a() { //c
}
int a = 1 + (d + 3); //d
int a(int b, int c) { //e
}
a++;
4. 其它规范
a. 变量一行一行的定义，最好别定义在一个int中，增强可读性
b. 一行就写一个语句，最好别两个语句写在一行
c. if 和 for 及时循环的只有一句话，也最好加上{}
//a
int a = 1;
int b = 2;
int a = 1, b = 2;//不推荐
//b:
a++;
b++;
a++; b++;//不推荐
//c
for(int a = 1; a < 100; a++){
x++;
}
for(int a = 1; a < 100; a++)//不推荐
x++;
内容总结
以上是互联网集市为您收集整理的Java03-命名规范/ 注释/ 排版(换行、空格)全部内容，希望文章能够帮你解决Java03-命名规范/ 注释/ 排版(换行、空格)所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。