首页 新闻 赞助 找找看

代码里面文档注释到底该怎样写

0
悬赏园豆:5 [已解决问题] 解决于 2018-01-15 16:57

写注释好还是不写注释,什么时候写注释,有人说好的命名就不用写注释了。对于那些有技术含量的代码是一定要写注释吧?不然别人看不懂?

个人觉得在未来,中文语言下面还是会有英文语言的,对于程序而言,英文语言上还是有必要加上中文吧

名字什么都是浮云的主页 名字什么都是浮云 | 菜鸟二级 | 园豆:327
提问于:2017-12-20 11:30
< >
分享
最佳答案
0

 当然写注释好 注释可以方便别人理解或维护你的项目

收获园豆:5
ycyzharry | 高人七级 |园豆:25639 | 2017-12-20 13:25
其他回答(5)
0

其实注释的作用往往是给下一个开发这个项目的人的,你如果一看这代码就知道干啥的,就不用注释了,如果逻辑复杂的话,还是有必要注释的。

BUTTERAPPLE | 园豆:3190 (老鸟四级) | 2017-12-20 11:31
0

https://zhuanlan.zhihu.com/p/25492689

子瓜01 | 园豆:239 (菜鸟二级) | 2017-12-20 11:56
0

写注释需要考虑一点,如何与代码的变更保持同步,如果注释内容与代码实现关联过于紧密,往往容易出现这样的问题——改了代码,没改注释。过时的注释还不如不写注释

dudu | 园豆:31075 (高人七级) | 2017-12-20 12:03
0

方法名就是最好的注释~    

顾星河 | 园豆:7169 (大侠五级) | 2017-12-20 13:26
0

BAD:

//return next day's time

public DateTime GetNextDayTime()

{

  Thread.Sleep(86400*1000);

  return DateTime.Now;

}

//get user's name

public string GetUserName(string userId)

{

  ....update db.... 

  ....get username

}

//check if is true

public bool Check(....)

{

  ...balabalalba...

  return false;

}

 

GOOD:

class xxxx:IDisposable

{

  ....

  public void Dispose()

  {

    ....clean 

    GC.SuppressFinalize(this);

  }

  ~xxxx()

  {

    throw new Exception("WTF");

  }

}

Daniel Cai | 园豆:10424 (专家六级) | 2017-12-20 14:47
清除回答草稿
   您需要登录以后才能回答,未注册用户请先注册