Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 569 Bytes

File metadata and controls

19 lines (14 loc) · 569 Bytes

总规范

  • 说明性内容(例如提交说明、文档、注释、mermaid),以中文为主,专有名词、约定俗称可用英文

Markdown 规范

  • 不使用---分割器
  • # Heading 一级标题仅用于开头
  • mermaid 节点名用英文字符

代码规范

  • 避免嵌套结构
  • 特殊的、非常规的需要写注释
  • 变量、函数名、Docstring 用全英文
  • 同一事物用统一表达
  • 使用的依赖越少越好
  • 选用简单直接的方式实现
  • 代码、执行方式改变,调整已有的文档、计划,而非新建