web程序员应该避免的五种代码注释是什么
导读:本文共1899字符,通常情况下阅读需要6分钟。同时您也可以点击右侧朗读,来听本文内容。按键盘←(左) →(右) 方向键可以翻页。
摘要: 1.自以为很了不得的程序员publicclassProgram{staticvoidMain(string[]args){stringmessage="HelloWorld!";//07/24/2010BobConsole.WriteLine(message);//07/24/2010Bobmessage="Iamsoproudof... ...
目录
(为您整理了一些要点),点击可以直达。1.自以为很了不得的程序员
这个程序员自认为写了一段很了不得的代码,所以觉得有必要用自己的名字对每行代码进行标记。实施版本控制系统(VCS)能实现对代码变更的问责,但是也不会这么明显知道谁应对此负责。
2.过时的程序员
如果一段代码已不再使用(即过时),那就删除它——不要浪费时间给这些代码写注释。此外,如果你需要复制这段被删除的代码,别忘了还有版本控制系统,你完全可以从早期的版本中恢复代码。
3.多此一举的程序员
我们都知道基础的编程逻辑是如何工作的——所以你不需要多此一举来解释这些显而易见的工作原理,虽然说你解释得很happy,但这只是在浪费时间和空间。
4.爱讲故事的程序员
如果你一定要在注释里提及需求,那么不要涉及别人的名字。销售部门的Jim可能会离开公司,而且很有可能大多数程序员根本不知道这是何许人也。不要在注释里提及不相干的事实。
5.“以后再做”的程序员
这种类型的注释包含了上面所有其他类型。如果是在项目的初始开发阶段,这种待做注释是非常有用的,但如果是在几年后的产品代码——那就会出问题了。如果有什么需要修复的,立马解决,不要把它搁置一边,“以后再做”。
web程序员应该避免的五种代码注释是什么的详细内容,希望对您有所帮助,信息来源于网络。