由于经常做代码走查的缘故,看了很多代码。
不少代码看起来注释很多,函数头写的很仔细,很符合公司所谓的规范,但千篇一律,无非就是函数名称,参数名称、类型,目的、作者、修改时间、修改内容。
不说别的,修改时间和修改内容这些东西,不是svn这类源码控制工具来做的吗?
我个人对这些标准的函数头深恶痛绝,就像前方100米有摊狗屎(如果你承认在你眼里大多数代码都像狗屎一样),本来你在狗屎那里放个牌坊就行了。结果你每隔10米给放一个牌坊(还是横在马路上的),我还得跨过去。本来好好的路,没有牌坊我走的会挺顺畅的,你加了牌坊,不仅没起多大作用,反而让读者觉得这个过程充满了狗屎味道。
《代码大全》说的很明白了,要尽量写自注释代码。
举个例子:
我们要找zte上研所,你是这样写:
Company zte =City["shanghai"]->Area["pudong"]->Street["bibo"]->Code[889]
还是:
Company ZTE()
{
returnCity["shanghai"]->Area["pudong"]->Street["bibo"]->Code[889];
}
让你的代码的读者,像阅读小说一样去理解代码的情节,而不是让本来好懂的逻辑,反而因为注释,变得很糟糕。