跳到主要内容

编程风格建议

本章节会记录一些我认为的编程最佳实践和最优方案,会以 TypeScript 的 Web 泛前端开发为主

用词约定

本文的情态动词遵循 RFC 2119 中的规定。 即以下词汇用作情态动词、状语、定语时,应作如下解释。

必须

表示在该上下文条件下,绝对不可违背。

禁止

表示在该上下文条件下,绝对不可实施。

建议、应该

表示在该上下文条件下,建议实施,优先实施,但并非绝对强制约束,可在获得团队认可的前提下适当饶过该限制。

不建议、不应该

表示在该上下文条件下,不建议实施,最好不实施,但并非绝对强制约束,可在获得团队认可的前提下适当饶过该限制。

允许

表示在该上下文条件下,准许实施,但并非推荐或鼓励的行为,应当在项目管理人员指导下实施。

总结

实施强度如下: 必须 == 禁止 > 建议 == 不建议 > 允许

以上词汇用作如上解释时,会以加粗斜体显示。