生成注释_java基础- Java编程规范与注释
一 前言
java编程规约是指在java代码编写过程中通俗的约定;通常我们是要遵守这些规范;这好比我们在生活中要遵守的道德准则,如果你做的事情超出了道德的底线,那就有可能会受到社会抨击;在java编程中也是类似的道理,如果你编写的代码不是很规范,尽管功能实现的功能强大,但其他java编程人员都看不懂你的代码,别人就认为你这是垃圾代码,后期的维护工作就会很艰难,而且心里肯定对你很不爽;如果在工作中遇见这种情况,你l的eader就有可能让你重写编写代码;
二 命名规范
良好的代码命名规则习惯有助于我们快速浏览代码,让代码的可读性强,易于他人阅读,后期维护工作简单;
2.1 驼峰命名法
驼峰命名法(Camel-Case)是程序编程的通俗约定,其分为大驼峰写法和小驼峰写法;
- 大驼峰:每一个单词首字母大写,随后的字母小写;示例:ILoveJavaProgramer
- 小驼峰: 第一个单词全小写,之后的单词首字母大写,其余字母小写;示例:iLoveJavaProgramer
2.2 包名写法
比如我有个域名是: java.com; 我现在要创建工程的包结构,那么通常包的命名规则是将域名反写,之后跟具体的包名;所有的包名都统一使用小写;
示例:com.java.zszxz.service
2.3 类名,接口名,文件名写法
类名,接口名,文件名写法统一采用大驼峰写法;
示例:
- 类名:FileInputStream
- 接口名:InputStream
- 文件名:UserMapper.xml
2.4 方法名,字段名写法
方法名 和 字段名称 统一采用小驼峰命名写法;
示例:
- 方法名:getUser()
- 字段名: fieldInfomation
2.4 常量名写法
常量是特殊的字段,也就是特殊的变量,其约定的写法跟之前稍有不同,其采用的写法是所有单词的字母都大写,单词之间使用下划线隔开;
示例: I_LOVE_JAVA_PROGRAMER
三 代码注释
代码的注释的作用主要是进行代码解释,类似你买了一个硬件设备,你要看说明书才知道怎么用这个设备,注释就起到了说明书的功能;代码注释的第二个功能是能注释到你当前写的代码,但后面又可能用到该代码,舍不得删除的情况;
3.1 单行注释
单行注释源于c++,其意指能注释掉一行代码,使用两个斜杆(//);
示例: // 我是知识追寻者,你是谁?觉得文章不错能帮助到你,那还不关注下?
3.2 多行注释
多行注释的风格源于c;其是斜杆和星号开头,中间部分是内容,以星号和斜杆结束(/ ............... /);
示例: / 今天你的小伙伴来找你了吗? /
3.3 文档注释
文档注释是指能够通过jdk的javadoc命令使注释生成html帮助文档,比如开发人员常看的jdk 的 API帮助文档;使用格式是以斜杆和2个星号开头,中间是内容,以星号和斜杆结束(/* .................... /);
通常文档注释只对 public 和 protect 级别的的成员进行注释,内部私有的成员是不提供给外部;
常用标签介绍:
了解更多标签示例请看:java文档注释
使用示例:
public class Doc {@Deprecatedprivate String buguaiguai;private String love;/*** @see java.lang.Object#toString()* @see java.lang.String* @see String* {@link System}* {@link System#getProperties()}* <a href="{@docRoot}/java/lang/doc-files/ValueBased.html">value-based</a>* @param love is favorite* @return the love* @deprecated <p>buguaiguai</p>* @throws RuntimeException contribution the java world* @since zszxz* @version 1.0.0* @author lsc/zszxz/youku1327*/public String getLove(String love){return "love";}
}
生成doc命令
javadoc -d tagerPath sourcePath/className.java
命令过程:
C:Users林>javadoc -d C:mydatageneratordoc C:javaworkspaceforresourcestudy-01basesrcmainjavacomyouku1327basedocDoc.java
正在加载源文件C:javaworkspaceforresourcestudy-01basesrcmainjavacomyouku1327basedocDoc.java...
正在构造 Javadoc 信息...
正在创建目标目录: "C:mydatageneratordoc"
标准 Doclet 版本 1.8.0_131
正在构建所有程序包和类的树...
正在生成C:mydatageneratordoccomyouku1327basedocDoc.html...
正在生成C:mydatageneratordoccomyouku1327basedocpackage-frame.html...
正在生成C:mydatageneratordoccomyouku1327basedocpackage-summary.html...
正在生成C:mydatageneratordoccomyouku1327basedocpackage-tree.html...
正在生成C:mydatageneratordocconstant-values.html...
正在构建所有程序包和类的索引...
正在生成C:mydatageneratordocoverview-tree.html...
正在生成C:mydatageneratordocindex-all.html...
正在生成C:mydatageneratordocdeprecated-list.html...
正在构建所有类的索引...
正在生成C:mydatageneratordocallclasses-frame.html...
正在生成C:mydatageneratordocallclasses-noframe.html...
正在生成C:mydatageneratordocindex.html...
正在生成C:mydatageneratordochelp-doc.html...C:Users林>
生成结果:
四 空行与缩进
4.1 空行
空行是指不同功能的代码之间要做到空行,以便于区分;
- 通常类名接口名,与其成员保持2个空行,如果有注释其也算一个空行;
- 不同类别的成员之间保持一个空行;
- 方法逻辑与方法名空一行;
示例:
/*
* 类的注释不需要空行
* /
public class zszxz {// 成员与类或者接口包池2个空行,包括注释;private String love;private Integer age; // 不同类别的成员保持一行private String gender;// 相同类名的成员不用空行public String getLove(){return "love"; // 方法逻辑与方法名空一行}}
4.2 缩进
类和属性;方法和逻辑;它们之间的缩进都是以4个空格为单位,可以使用制表符来代替多个空格,作者的一个制表符设置的是2个空格;
示例:
/*
* 类的开头不需要空格
* /
public class zszxz {// 成员与类或者接口保持4个空格private String love;private Integer age; // 成员与类或者接口保持4个空格private String gender;// 成员与类或者接口保持4个空格public String getLove(){ //成员与类或者接口保持4个空格return "love"; // 方法逻辑与方法名保持4个空格}}
生成注释_java基础- Java编程规范与注释相关推荐
- html 注释_java基础- Java编程规范与注释
一 前言 java编程规约是指在java代码编写过程中通俗的约定:通常我们是要遵守这些规范:这好比我们在生活中要遵守的道德准则,如果你做的事情超出了道德的底线,那就有可能会受到社会抨击:在java编程 ...
- java编程规范换行_Java编程规范整理
近期即将开始编码阶段,特地整理一下各方面的编程规范与命名约定,以便内部团队风格统一. 文章大多从网络上收集汇总而来,参考列表附在文章末尾. Java编程规范整理 基本命名规范 包命名 包名按照域名的范 ...
- java 标识变量_Java变量与数据类型之一:Java编程规范,关键字与标识符
原标题:Java变量与数据类型之一:Java编程规范,关键字与标识符 大家好,这次要给大家带来的是Java变量与数据类型.本文是第一集:Java编程规范,关键字与标识符. 一.编程规范 任何地方的名字 ...
- JAVA编程规范总结
JAVA编程规范总结: 1.编码规范好处: 1.减少维护成本和时间 2.增加可读性,方便自己和维护的技术人员二次改善 3.提高开发效率,团队协作 4.养成好习惯,提高自身修炼 2.命名规范: 1.尽量 ...
- Java编程规范(一)
Java编程规范 编程规约 命名风格 常量定义 代码格式 OOP约束 来源:阿里巴巴 编程规约 命名风格 不能以下划线或者美元符号开始或结束 **反例**:_name / __name / $name ...
- java与数据类型相关的十个关键字_乐字节Java变量与数据类型之一:Java编程规范,关键字与标识符...
大家好,这次要给大家带来的是Java变量与数据类型.本文是第一集:Java编程规范,关键字与标识符. 一.编程规范 任何地方的名字都需要见名知意: 代码适当缩进 书写过程成对编程 对代码进行合理注释 ...
- “华为云企业级Java编程规范”学习笔记
一."Java基础语句"编程规范 Switch 语句要有defualt分支,除非Swich的条件变量是枚举类型; 多条件分支语句最后应包含一个else分支; 二."类的使 ...
- 阿里巴巴Java开发规范线程池_阿里巴巴java编程规范.pdf
阿里巴巴java编程规范 目录 一.编程规约1 (一) 命名规约1 (二) 常量定义3 (三) 格式规约4 (四) OOP 规约6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 1 ...
- sun公司java编程规范【转载】
java编程规范要学习的大致内容有如下部分,一个目录: Java编码规范 1 1.说明 3 1.1为什么要有编码规范 3 1.2版权声明 3 2.文件名(File Names) 3 2.1文件后缀(F ...
最新文章
- 黑马vue---8-10、v-cloak、v-text、v-html、v-bind、v-on的基本使用
- 终结者:具体解释Nginx(一)
- Eclipse常用快捷键与代码模板
- 解决Tensorflow2.0出现:AttributeError: module 'tensorflow' has no attribute 'get_default_graph'的问题
- [Django]Windows下的Django安装——通过pip
- 谭浩强《C语言程序设计第五版》第二章学习笔记
- 安川机器人报错_安川机器人伺服驱动器常见的报警代码
- python入门指南by许半仙-《江火欲燃山》《这题超纲了》《Python入门指南》
- asp站点服务器,ASP网站搭建 ASP服务器搭建 教程
- 趣图 | EDG牛逼!!!
- Longitudinal Statistics 纵向统计分析
- bootstrap 图片上传框架
- visual basic 6 下载 和 Vb6sp6 下载
- 幂级数和函数经典例题_10函数项级数和幂级数 习题课
- [配置]keepalived配置高可用虚拟IP不通
- 【两化融合】新一代信息技术怎样与制造业深度融合?
- 安卓逆向之双剑合璧实现内存扫描
- 微信小程序 uChars统计图
- C++数据类型 浅显理解
- 2022-2027年中国B2C电子商务行业市场深度分析及投资战略规划报告
热门文章
- 改改Python代码,运行速度还能提升6万倍
- 基於MySQL+PHP的羽毛球費用查询网站设计
- cpu 保存模式的内存访问向下兼容原理
- linux03-学习记录
- 原生开发安卓/iOS,Visual Studio迎神器扩展
- Python《爬取手机和桌面壁纸》
- 漫步数理统计十八——相关系数
- 牛津书虫系列_【SHARE】牛津书虫系列英文书
- python 获取键盘输入、同时有超时的功能_python 获取键盘输入,同时有超时的功能示例...
- python点击网页按钮 没有id_button没有id,没有onclick事件。点击却有提交的功能,如何实现的?...