形式

嵌入代码的注释

  • 大部分语言都支持markdown注释
  • 代码本身就有逻辑性

缺点

  • 难以理解

优点

  • 保持最终产品逻辑与解释一致

独立文档

场景

  • 需要跳出代码结构,使用另一种结构解释逻辑时
  • 当需要复杂的进行解释时, 使用开发文档进行解释

缺点

  • 需要手动将开发文档与代码逻辑进行同步