文档章节

文档注释规范

侯法超
 侯法超
发布于 01/09 21:26
字数 244
阅读 27
收藏 0

包描述

我们功能一般是分包开发的,在包下创建一个package.html,在包里简要描述本包的功能。 模板:

<html>
<body>
package description
</body>
</html>

类描述

可以用较长的文字说明该类是的功能,最好的方式是其他人只读类描述就能知道这个类是做什么的,应该有什么样的方法。 基本模板:

<h1>标题</h1>
<p>主要内容进行<strong>强调</strong>,更多信息查看{@link Object}</p>

在eclipse中设置创建类时的模板 在eclipse菜单

Window -> Preferences -> Java -> Code Style –> Code Templates

中,选择Comments中的Types,编辑

<p>Copyright (c).</p>
@author author
@since 
@version 

方法描述

方法描述要说明方法做了什么,有什么影响,使用时有什么要注意的;可以不用说具体怎么做。 @param @return @throws都要进行说明

成员变量描述

简要说明成员变量的意义。

/**
 * field description
 */
private String field

© 著作权归作者所有

共有 人打赏支持
侯法超
粉丝 152
博文 57
码字总数 105341
作品 0
大兴
程序员
私信 提问
《Python从小白到大牛》第5章 Python编码规范

俗话说:“没有规矩不成方圆”。编程工作往往都是一个团队协同进行,因而一致的编码规范非常有必要,这样写成的代码便于团队中的其他人员阅读,也便于编写者自己以后阅读。 提示 关于本书的P...

tony关东升
07/04
0
0
IOS Android项目注释规范

场景描述:最近整理公司开发的项目,发现公司项目很多地方写的不规范,尤其是注释;这对以后维护和开发带来了很多不便。尤其对于对项目本身不熟悉的人,在没有注释的情况下看项目会很费劲,通...

malawo
2013/08/17
0
0
Javascript代码及注释规范

Javascript代码及注释规范 为规范前端开发代码,提高代码质量,特制定此文档,其中声明,安全和分号这三节是必须执行的,组件类必须遵循注释规范。 声明 变量声明必须加var关键字,严格控制作...

geekcarnegie
2014/05/16
0
0
入职学习(3)--一个程序员的成长史(23)

看完了《C语言编程规范》,代是雄接着看《数据库编程规范》。之前赖科长和邹总都说过,本项目组开发主要涉及到的技术就是C语言和数据库,既然有了C语言的编程规范,那么就会有对应的数据库的...

zhouzxi
2017/01/14
0
0
腾讯云 COS 对象存储 Ruby SDK 需求

腾讯云通过云 API(HTTPS 协议)对外提供开发者服务,通过云 API 开发者可以管理云资源、使用云服务。现腾讯云与开源中国众包平台合作「腾讯云开源众包计划」,让外部开发者来一起建立云 AP...

腾讯云
2015/12/29
78
1

没有更多内容

加载失败,请刷新页面

加载更多

Spring源码学习笔记-1-Resource

打算补下基础,学习下Spring源码,参考书籍是《Spring源码深度解析》,使用版本是Spring 3.2.x,本来想试图用脑图记录的,发现代码部分不好贴,还是作罢,这里只大略记录下想法,不写太细了 ...

zypy333
今天
11
0
RestClientUtil和ConfigRestClientUtil区别说明

RestClientUtil directly executes the DSL defined in the code. ConfigRestClientUtil gets the DSL defined in the configuration file by the DSL name and executes it. RestClientUtil......

bboss
今天
17
0

中国龙-扬科
昨天
2
0
Linux系统设置全局的默认网络代理

更改全局配置文件/etc/profile all_proxy="all_proxy=socks://rahowviahva.ml:80/"ftp_proxy="ftp_proxy=http://rahowviahva.ml:80/"http_proxy="http_proxy=http://rahowviahva.ml:80/"......

临江仙卜算子
昨天
11
0
java框架学习日志-6(bean作用域和自动装配)

本章补充bean的作用域和自动装配 bean作用域 之前提到可以用scope来设置单例模式 <bean id="type" class="cn.dota2.tpye.Type" scope="singleton"></bean> 除此之外还有几种用法 singleton:......

白话
昨天
10
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部