首页 > 教程 > 关键词  > 代码注释最新资讯  > 正文

养成好习惯 关于代码注释的13个技巧

2009-01-04 09:20 · 稿源:DevTopics

《养成好习惯 关于代码注释的13个技巧》文章已经归档,站长之家不再展示相关内容,下文是站长之家的自动化写作机器人,通过算法提取的文章重点内容。这只AI还很年轻,欢迎联系我们帮它成长:

首先把代码块分解成多个“段落”,每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释,告诉阅读代码的人接下来的这段代码是干什么用的...

这样的注释对于代码的写注释的人来说并没有任何好处,同时你永远都不会知道将来这些注释会被谁来阅读,你的老板,一个客户或者是刚才被你数落的愚蠢得可怜的工程师...

当你在写代码而且记忆犹新的同时就添加注释...

代码和注释需要同步,否则注释只会让维护代码的开发者更加痛苦...

虽然有人怀疑这是由不喜欢写注释的程序员所倡导的一场运动,但是无需解释的代码有很大的好处,这些代码更加容易理解甚至让注释变得没有必要...

如果代码不遵守这条技巧,那么注释看起来就好像是为自己不好的代码的写道歉信一样...

......

本文由站长之家用户“DevTopics”投稿,本平台仅提供信息索引服务。由于内容发布时间超过平台更新维护时间,为了保证文章信息的及时性,内容观点的准确性,平台将不提供完整的内容展现,本页面内容仅为平台搜索索引使用。需阅读完整内容的用户,请联系作者获取原文。

举报

  • 相关推荐
  • 大家在看

今日大家都在搜的词: