论坛首页 Java企业应用论坛

千万要避免的五种程序注释方式

浏览 6287 次
该帖已经被评为隐藏帖
作者 正文
   发表时间:2010-08-20  
select*from爱 写道
当年在在一个神奇的系统 ibatis配置xml看到的一段注释
/**
*这是一段很长的sql语句
*由于语句太长,你可能看不懂,请参照本人写的数字驱动 com.......java
*如果到现在还看不动,请打电话问川,TEL:13xxxxxxxxx
*如果川无法搞定,或电话无法接通,请加本人qq.....
*
*/
select ... from .......

排这个
0 请登录后投票
   发表时间:2010-08-20  
我写注释都是方法前
/**
* 功能描述:这个方法是做什么的
*   逻辑判断:step1:判断a
*            step2:判断b
*
*   modify 2010-08-20 author 增加判断 step3:判断c
*/

方法中也有相应的 step注释。


请高手指正
0 请登录后投票
   发表时间:2010-08-20  
关注~!大家都来晒晒代码注释吧~!
0 请登录后投票
   发表时间:2010-08-20  
内容有点意思。可是不是原创,我以前看过。
0 请登录后投票
   发表时间:2010-08-20  
select*from爱 写道
当年在在一个神奇的系统 ibatis配置xml看到的一段注释
/**
*这是一段很长的sql语句
*由于语句太长,你可能看不懂,请参照本人写的数字驱动 com.......java
*如果到现在还看不动,请打电话问川,TEL:13xxxxxxxxx
*如果川无法搞定,或电话无法接通,请加本人qq.....
*
*/
select ... from .......


呵呵,注释的逻辑比程序复杂...
0 请登录后投票
   发表时间:2010-08-20  
我靠,je  bug

我明明点的是隐藏,结果跑到精华上去了。

---------

个人观点,天马行空的注释也比没有注释的好。
0 请登录后投票
   发表时间:2010-08-20  
此贴必火!
编程中我也经常犯这些错误,学习了

select*from爱 写道
当年在在一个神奇的系统 ibatis配置xml看到的一段注释
/**
*这是一段很长的sql语句
*由于语句太长,你可能看不懂,请参照本人写的数字驱动 com.......java
*如果到现在还看不动,请打电话问川,TEL:13xxxxxxxxx
*如果川无法搞定,或电话无法接通,请加本人qq.....
*
*/
select ... from .......

0 请登录后投票
   发表时间:2010-08-20  
je的风格不是原创吗?
炒旧饭和转载应该是投隐藏啊。
0 请登录后投票
   发表时间:2010-08-20  
衡量代码好坏其实就一种方式:是否感觉得爽。
感觉不爽,那就是有问题。同样适用于注释。

0 请登录后投票
   发表时间:2010-08-20  
NanguoCoffee 写道
衡量代码好坏其实就一种方式:是否感觉得爽。
感觉不爽,那就是有问题。同样适用于注释。


考虑代码的注释
1、可能是给别人看的,也可以是给自己看的,
所以,任何的相关思维碎片都可以写

2、参照office批注,我觉得这个是以后代码注释的一个发展方向,
特别是在多人合作的团队里。
留下的修改和思考历程,都是可以记录,以后再详细说明的。
0 请登录后投票
论坛首页 Java企业应用版

跳转论坛:
Global site tag (gtag.js) - Google Analytics