|
已锁定 主题： 程序员为什么不写单元测试
该帖已经被评为良好帖
|
|
|---|---|
| 作者 | 正文 |
|
发表时间：2007-07-12
javaTo 写道 代码当然是要看的，但对于一段代码的清晰度，有良好的注释还是很重要的
/**
* 保存Excel报表到指定的路径
* @param beans 公用报表Bean
* @param destFileName 报表生成路径
* @throws FileNotFoundException
* @see ExpenseGrowRate
*/
protected void transformer(Map<String, Envelope> beans, String destFileName)
throws FileNotFoundException {
// ...
}
你这基本上是个反面教材 如果方法名和变量名取的好一点,这些注释都可以去掉 |
| 返回顶楼 | |
|
发表时间：2007-07-12
daquan198163 写道 javaTo 写道 代码当然是要看的，但对于一段代码的清晰度，有良好的注释还是很重要的
/**
* 保存Excel报表到指定的路径
* @param beans 公用报表Bean
* @param destFileName 报表生成路径
* @throws FileNotFoundException
* @see ExpenseGrowRate
*/
protected void transformer(Map<String, Envelope> beans, String destFileName)
throws FileNotFoundException {
// ...
}
你这基本上是个反面教材 如果方法名和变量名取的好一点,这些注释都可以去掉 假如我不写注释，你一眼就可以看出他的功能吗？最起码你要把他的源码看一遍才知道他是做什么的吧，如果这个方法很复杂呢，你可能就要看N遍才能理解，而如果这样写我只要10秒钟就会使用这个方法了。两者之间你愿意选择哪种呢？ 如果你想用方法名来说明某个方法的意思，估计你的很多方法名称就要写成句子而不是单词了 |
| 返回顶楼 | |
|
发表时间：2007-07-12
javaTo 写道 如果你想用方法名来说明某个方法的意思，估计你的很多方法名称就要写成句子而不是单词了 句子倒不必,一个短语足矣. 这有什么不妥么? 比如把transformer改成storeExcelToPath(Map<String, Envelope> commonReportBeans, String destPath) |
| 返回顶楼 | |
|
发表时间：2007-07-12
方法命名，建议使用 动词 加上宾语补足语
|
| 返回顶楼 | |
|
发表时间：2007-07-16
.........不写注释？
不知道你们都怎么样开发产品的。 不过我知道如果不写注释的话api是不会自动生成的。 每个接口都要写注释 工具类也都必须写注释否则eclipse 不会把工具的作用弹出来的。 死抱着先人的理论不干活的人们脑子是否锈了？ 软件是写出来的不是吹出来的。 自己在自己的项目中用用两种方式后再来显摆。 我认为gigix可以写代码不写注释 但普通公司不行。 原因只有一个：英文不是我们的母语。 PS：以上为跑题贴 不知道楼主的文章什么时候写完 |
| 返回顶楼 | |
|
发表时间：2007-07-16
javadoc依赖注释么?
英文不是我们的母语这算什么理由? |
| 返回顶楼 | |
|
发表时间：2007-07-16
这也不过是个权衡的问题。给方法、变量、参数起一个好的名字会费力气，是吧，因为英文不是我们的母语。那么每当修改这些东西的时候你就跟着一道改注释吧。一件事情在两个地方描述吧。如果你认为这样的成本是可以接受的，谁也不能批评你什么。
|
| 返回顶楼 | |
|
发表时间：2007-07-16
抛出异常的爱 写道 .........不写注释？
不知道你们都怎么样开发产品的。 不过我知道如果不写注释的话api是不会自动生成的。 每个接口都要写注释 工具类也都必须写注释否则eclipse 不会把工具的作用弹出来的。 死抱着先人的理论不干活的人们脑子是否锈了？ 软件是写出来的不是吹出来的。 自己在自己的项目中用用两种方式后再来显摆。 我认为gigix可以写代码不写注释 但普通公司不行。 原因只有一个：英文不是我们的母语。 PS：以上为跑题贴 不知道楼主的文章什么时候写完 近期烦其它的事情！我会写的！ |
| 返回顶楼 | |
|
发表时间：2007-07-17
code review更重要
|
| 返回顶楼 | |
|
发表时间：2007-07-17
daquan198163 写道 javaTo 写道 代码当然是要看的，但对于一段代码的清晰度，有良好的注释还是很重要的
/**
* 保存Excel报表到指定的路径
* @param beans 公用报表Bean
* @param destFileName 报表生成路径
* @throws FileNotFoundException
* @see ExpenseGrowRate
*/
protected void transformer(Map<String, Envelope> beans, String destFileName)
throws FileNotFoundException {
// ...
}
你这基本上是个反面教材 如果方法名和变量名取的好一点,这些注释都可以去掉 我觉得变量名没什么问题。但是就算变量名取得好，javadoc 文档也是要写的，不能省。本例中缺少了对异常抛出条件的说明，这是不应该的。 |
| 返回顶楼 | |
