Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 832 Bytes

0-preface.md

File metadata and controls

15 lines (8 loc) · 832 Bytes

0. Preface

以下是我为同事们整理的最佳实践列表,这些建议源于处理他人代码时自然产生的痛苦经历:-)

定义一份最佳实践清单总是很难。我倾向于认为我们是在定义一种通信协议,因为我们确实是在这样做。因此本文档使用了 RFC 2119 中定义的关键字,以区分哪些规则是绝对不能违反的,哪些规则是知道自己在做什么就可以违反的。

这份名单还远远不够完整。

0.1. MUST NOT follow advice blindly

这应该是任何描述最佳实践的文件的第一条规则。

应始终努力理解规则背后的原因,不要盲目听从建议。否则会导致最糟糕的结果。