所有的程序员都应该以此为榜样
Martin在文中详细讨论了代码注释,我不会完全重复他的话。简而言之,他的意思就是,这些注释是注定会过时的。程序执行时会忽视注释,所以无法保证这些说明注释会准确的描述代码作用。所以最好的方式是让代码自说明,如此,按照代码逻辑,程序员和程序获取到的信息是一致的。
部分程序员认为,写代码是一个冗长且无趣的过程,不在代码注释里留下点吐槽、好玩的东西,对不起自己的千万行代码。所以,就有了各种各样或恶趣味、或啼笑皆非的代码注释。
在这些程序员的身上,我们看到的是,能力越大责任越小,而个人习性的劣根性反而暴露得越显著。
原来,在写代码的时候,为了让同事看懂这串代码的作用,程序员会对这行代码进行注释。而在虾米音乐MAC客户端的代码注释里,一位发帖人看到了这行代码……
曾经年少轻狂,写了三两行简简单单的逻辑代码,却总要在前头署上自己的大名,然后等到生产版本宕机那天,已经换了三四家的公司的你还是被无情夺命连环 Call 。曾经对面坐着的是个花一般的测试,然后代码的注释里,总是会多出好几排空格。曾经,我们在写代码时,还会有心情写注释。曾经,写注释时,身边还有你。望能博君一笑。
多年来,我非常荣幸能和一些谦逊的公司和客户合作。我也因此有机会接触到各种不同的程序员—— 每个程序员都有自己独特的风格。事实上,每个项目本身都有一些独特的元素。
你有没有这样的经历:别人审查过你的代码之后给出的注释,你认为是没有必要的?注释代码是为了提高代码的可读性,目的是为了能让其他人更容易理解你的代码。
应该还能用
【外评】谷歌:从源头消除内存安全漏洞
【外评】在 RiSC-V 上运行《巫师 3》游戏
【外评】法官驳回大部分 GitHub Copilot 版权索赔要求
谷歌内部推出 SQL 中的管道(Pipe)语法
你们干扰不了我写开源代码
【外评】FreeBSD 将 Rust 纳入基本系统
【外评】电脑从哪里获取时间?
【外评】为什么 Stack Overflow 正在消失?
有时