×
思维导图备注
Google Java编程风格规范
首页
白天
夜间
小程序
阅读
书签
我的书签
添加书签
移除书签
哪里需要使用Javadoc
浏览
627
扫码
分享
2018-04-16 20:46:58
7.3 哪里需要使用Javadoc
7.3 哪里需要使用Javadoc
至少在每个public类及它的每个public和protected成员处使用Javadoc,以下是一些例外:
上一篇:
下一篇:
说明
前言
术语说明
指南说明
源文件基础
文件名
文件编码:UTF-8
特殊字符
空白字符
特殊转义序列
非ASCII字符
源文件结构
许可证或版权信息
package语句
import语句
import不要使用通配符
不要换行
顺序和间距
类声明
只有一个顶级类声明
类成员顺序
格式
大括号
使用大括号(即使是可选的)
非空块:K & R 风格
空块:可以用简洁版本
块缩进:2个空格
一行一个语句
列限制:80或100
自动换行
从哪里断开
自动换行时缩进至少+4个空格
空白
垂直空白
水平空白
水平对齐:不做要求
用小括号来限定组:推荐
枚举类
枚举类
变量声明
数组
switch语句
注解(Annotations)
注释
Modifiers
命名
对所有标识符都通用的规则
标识符类型的规则
包名
类名
方法名
常量名
非常量字段名
参数名
局部变量名
类型变量名
驼峰式命名法(CamelCase)
编程实践
@Override:能用则用
捕获的异常:不能忽视
静态成员:使用类进行调用
Finalizers: 禁用
Javadoc
格式
一般形式
段落
Javadoc标记
摘要片段
哪里需要使用Javadoc
例外:不言自明的方法
例外:重载
可选的Javadoc
暂无相关搜索结果!
本文档使用
BookStack
构建
×
分享,让知识传承更久远
×
文章二维码
手机扫一扫,轻松掌上读
×
文档下载
普通下载
下载码下载(免登录无限下载)
你与大神的距离,只差一个APP
请下载您需要的格式的文档,随时随地,享受汲取知识的乐趣!
PDF
文档
EPUB
文档
MOBI
文档
温馨提示
每天每在网站阅读学习一分钟时长可下载一本电子书,每天连续签到可增加阅读时长
下载码方式下载:免费、免登录、无限制。
免费获取下载码
下载码
文档格式
PDF
EPUB
MOBI
码上下载
×
微信小程序阅读
您与他人的薪资差距,只差一个随时随地学习的小程序
×
书签列表
×
阅读记录
阅读进度:
0.00%
(
0/0
)
重置阅读进度