Martin(Bob大叔)曾在《代码整洁之道》一书打趣地说:当你的代码在做 Code Review 时,审查者要是愤怒地吼道:
“What the fuck is this shit?”
“Dude, What the fuck!”
等言辞激烈的词语时,那说明你写的代码是 Bad Code,如果审查者只是漫不经心的吐出几个
“What the fuck?”,
那说明你写的是 Good Code。衡量代码质量的唯一标准就是每分钟骂出“WTF” 的频率
。
衡量文档的标准也是如此。
切记,编写文档的目的是为了让读者可以快速有效地获取他想知道的信息。