Java-002 变量命名规则
所有语言公共的部分略过
重点部份:
Java注释:
1>.单行注释。 以双斜杠‘//’表示,只能注释以昂内容,用在注释信息内容少的地方。
2>.多行注释。包含在‘/*’ 和 ‘*/’之间,能注释很多行的内容。为了可读性比较好,一般首行不谢注释信息(这样也比较美观好看)。
例子:/*
* 这是多行注释
* 这是多行注释
*/
3>.文档注释。包含在‘/**’和‘*/’之间,叶梦注释多行内容,一般作用在类,方法和变量上面,用来描述其作用。注释后,鼠标放在类和变量上面会自动显示初我们注释的内容
Javadoc标签:
Javadoc工具可以识别文档注释中的一些特殊标签,这些标签一般以@开头,后跟一个制定的名字,有的也以{@开头,以}结束。Javadoc可以识别的标签如下标所示:
标签 | 描述 | 示例 |
---|---|---|
@author | 标识一个类的作者,一般用于类注释 | @author description |
@deprecated | 指名一个过期的类或成员,表明该类或方法不建议使用 | @deprecated description |
{@docRoot} | 指明当前文档根目录的路径 | Directory Path |
@exception | 可能抛出异常的说明,一般用于方法注释 | @exception exception-name explanation |
{@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
{@link} | 插入一个到另一个主题的链接 | {@link name text} |
{@linkplain} | 插入一个到另一个主题的链接,但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
@param | 说明一个方法的参数,一般用于方法注释 | @param parameter-name explanation |
@return | 说明返回值类型,一般用于方法注释,不能出现再构造方法中 | @return explanation |
@see | 指定一个到另一个主题的链接 | @see anchor |
@serial | 说明一个序列化属性 | @serial description |
@serialData | 说明通过 writeObject() 和 writeExternal() 方法写的数据 | @serialData description |
@serialField | 说明一个 ObjectStreamField 组件 | @serialField name type description |
@since | 说明从哪个版本起开始有了这个函数 | @since release |
@throws | 和 @exception 标签一样. | The @throws tag has the same meaning as the @exception tag. |
{@value} | 显示常量的值,该常量必须是 static 属性。 | Displays the value of a constant, which must be a static field. |
@version | 指定类的版本,一般用于类注释 | @version info |
对两种标签格式的说明:
. @tag格式的标签(不被{保卫的标签})为块标签,只能在主要描述(类注释中对改类的详细说明为主要描述)后面的标签部分(如果块标签放在主要描述的前面,则生成API帮助文档是会检测不到主要描述)。
. {@tag}格式的标签(由 {}包围的标签)为内联标签,可以放在主要描述中的任何位置或块标签的注释中。
Javadoc标签注意事项:
. Javadoc标签必须从一行的开头开始,否则将被视为普通文本。
. 一般具有相同名称的标签放在一起。
. Javadoc标签区分大小写,代码中对于大小写错误的标签不会发生编译错误,但是在生成API帮助文档是会检测不到该注释内容。
Javadoc命令:
javadoc 用法格式如下:
javadoc [options] [packagenames] [sourcefiles]
对格式的说明:
.options表示Javadoc命令的选项;
.packagenmes表示包名;
.sourcefiles 表示源文件名。
在cmd(命令提示符)中输入 javadoc -help 就可以看到Javadoc的用法和选项(前提是安装配置了JDK),下面列举Javadoc命令的常用选项:
名称 | 说明 |
---|---|
-public | 仅显示 public 类和成员 |
-protected | 显示 protected/public 类和成员(默认值) |
-package | 显示 package/protected/public 类和成员 |
-private | 显示所有类和成员 |
-d <directory> | 输出文件的目标目录 |
-version | 包含 @version 段 |
-author | 包含 @author 段 |
-splitindex | 将索引分为每个字母对应一个文件 |
-windowtitle <text> | 文档的浏览器窗口标题 |
例子:
/** * @author C语言中文网 * @version jdk1.8.0 */ public class Test{ /** * 求输入两个参数范围以内整数的和 * @param n 接收的第一个参数,范围起点 * @param m 接收的第二个参数,范围终点 * @return 两个参数范围以内整数的和 */ public int add(int n, int m) { int sum = 0; for (int i = n; i <= m; i++) { sum = sum + i; } return sum; } }
将文件命名为Test.java,打开cmd窗口,输入
javadoc -author -version Test.java命令,会生成一个包,网页版。
考虑编码格式的问题,注释中有汉字可能会乱码。使用javadoc -encoding UTF-8 -charset UTF-8 Test.java
会解决编码问题。
Java命名规范:
大坨峰命名规则(UpperCameCase):每个单词的第一个字母大写,其他字母小写。
小驼峰命名规则(lowerCameCase):如果仅有一个单词,那么所有字母全部小写,如果是了个及以上的单词组成的名称,那么出了第一个单词是全部小写外,其他单词首字母大写。
所有的命名都应该以字母(A-Z或者a-z),美元符($)或者下划线(_)开始;
首字符之后可以是字母(A-Z或者a-1),美元符($)或者下划线(_)或则数字的任何字符组合;
包的命名:
包的命名由全部小写的单词组成。一般使用公司的域名的座位自己程序包的唯一前缀,使用倒域名规则,例如:com.wch.项目名,燃机欧针对每个具体的模块在区分每个模块包名,例如:com.wch.项目名.crawl.
类的命名:
类的命名遵循大驼峰命名的规则,常见的命名规则如下:
类描述举例:
*****************************************后缀*****************************************
Activity类以Activity为后缀启动页面:LaunchActivity
Fragment类以Fragment为后缀论坛推荐列表:TribuneRecommendFragment
Adapter类以Adapter为后缀论坛适配器:TribuneAdapter
ViewHolder类以ViewHolder为后缀广告类型:AdViewHolder
Bean类以Bean为后缀新闻实体类:NewsBean
Model类以Model为后缀论坛推荐Model:TribuneRecommendModel
工具类以Util为后缀网络工具类:NetWorkUtil
Service类以Service为后缀音频服务:AudioService
BroadcastReceiver 类以Receiver为后缀音频广播:AudioReceiver
ContentProvider类以Provider为后缀联系人的内容提供者:ContactsProvider
Dialog类以Dialog为后缀加载:LoadingDialog
监听器类以Listener为后缀网络监听:NetWorkListener
*****************************************前缀*****************************************
自定义基础类以Base为前缀例如:BaseAcitvity,BaseFrangment
抽象类以Abstract或者Abs为前缀例如:AbsBean
管理类以Manager为后缀联系人管理类:ContactsManager
解析类以Parser为后缀新闻Json解析类:NewsJsonParser
接口的命名:
节后命名遵循大驼峰命名的规则,以大写的I开头,表示这是一个接口,以able或ible截尾。
变量命名:
变量的命名遵循小驼峰命名的规则,其中空间的变量建议使用空间缩写+逻辑名称的格式,例如:
private TextView tvUserName;.