程序员不撰写代码注释和文档的十大理由

在软件开发的世界中,撰写代码注释和文档通常被认为是一项重要的工作,它可以帮助其他开发者理解你的代码,更容易地维护和扩展它。然而,在实际操作中,很多程序员却选择不写注释或文档。以下列出了程序员们在实践中经常提到的十大理由,这些理由不仅揭示了他们对于撰写文档和注释的观点,也反映出软件开发行业中一些深层次的问题。

image.png
  1. 我们并非开发面向外部的 SDK,所以撰写文档似乎毫无必要。再者,写文档并不能作为 KPI 的一部分。

  2. 实际上,是因为工期过于紧迫。如果有充裕的时间,我甚至愿意增加单元测试。但现实是,刚刚完成一个项目,就有新的任务立刻接踵而至,没有时间让我们稍作休息。

  3. 有的时候,我们确实有文档,但却无法及时更新,全都是过时的内容。这种情况下,有文档反而不如没有,查阅文档往往不如直接看代码,但却让人误以为有文档就很方便。

  4. 在我的代码中,我几乎不写注释,API文档我会写在 wiki 中,代码规范,命名也规范。当你的代码规范、命名规范时,其实没有必要写注释。目录名、函数名和变量名就是最好的注释。

  5. 如果你的架构设计得很好,代码易读、易扩展,任何人都可以接手。这就让你成为一个“可有可无”的人。

  6. 如果你的代码写得很好,基本上没有 bug,而你又每天都不需要加班,你就被视为工作态度不积极的人。

  7. 如果你的代码写得很差,bug 层出不穷,每天都必须加班,你就成了公司的中坚力量。

  8. 如果你的架构一片混乱,除了你自己没有人敢接触你的代码,那你就是公司的重要人物,没有你,项目就会崩溃。

  9. 撰写文档和注释,需要体谅开发者的感受。正常的开发工时,我们至少需要一半的时间来写文档。如果没有这个时间,自然就不能写,这是毫无疑问的。

  10. 写注释是为了将来自己查看,而不是给后续接手的人看。如果自己都能看懂,就没必要写注释。代码的原则是:没有注释也能看懂的代码,才是最好的代码。

image.png

以上是程序员们不写代码注释和文档的十大理由,这些理由充分反映出他们在实际工作中的困扰和压力。但是,这并不意味着我们就可以忽视文档和注释的重要性。尽管在某些情况下,这些理由可能有一定的道理,但是好的代码注释和完善的文档无疑可以使我们的工作更加有效率,使其他开发者更容易地理解和维护我们的代码。为此,我们需要寻找一个平衡点,以满足项目的需求,同时也尽可能地减少对开发者的负担。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容