标签:理解 line format 包括 tin 需要 ring 标签 一句话
注释本身并没有什么好说的,无非就是三种注释,使用情况分别如下:
文档注释常采用一些Javadoc标签进行文档的特定用途描述,用于帮助Javadoc产生文档.
2.注释的内容
实验室一群菜鸡(包括我)写了一个项目,注释简直惨不忍睹,举个例子。
1. 几乎每个return上面都有一个
// 返回数值
恕我愚钝,我到现在还是没看懂这个注释的意思,当然不是说不理解他的意思,而是他的意义何在???
我觉得写代码的人应该都认识 return 吧。。。。
2. 特别喜欢当翻译。比如我们项目下有这样一条注释。
* @Title: getWeighs 获取称信息
外日,这些英文我懂,为了生成文档,但是这个中文,我就见了鬼了,即使是离代码最远的文档中我觉得这句话也好废物。
我觉得我应该认识 get 和 Weigh (即使不认识,也可以一秒百度),所以这句翻译的意义究竟在哪里??
3. 该注释的一句话都没写。
BaseUtil.initInfo(info, "startDatetime",startDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")), "endDatetime",
endDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
这么长的一段代码明显可以拆分成多个,但是宁愿别人浪费点时间去理解,也不愿意浪费空间去让其变简单。
改一下:
String stratDtStr = startDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")); String endDtStr = endDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")); BaseUtil.initInfo(info, "startDatetime",stratDtStr, "endDatetime",endDtStr);
明显更容易让读这段代码的人理解。。
当然我们在项目开发的时候需要调用他人提供的接口,于是"不得不"让一句代码很很佷长,比如下面这个情况。
标签:理解 line format 包括 tin 需要 ring 标签 一句话
原文地址:https://www.cnblogs.com/guodao/p/9803426.html