开发文档撰写约定
1. 小节的名称
每页文档都由若干个按功能区分的小节组成。(小节的描述,可以为空)
1.1 子小节的名称(小节通常也可以直接由若干个子小节构成,小节的名称与子小节的名称都可以是适用版本、子功能名称或者方法名等之一,主要看那种划分后续维护更方便。)
每个层级都可以有描述,可以为空。
1.1.1 如果你还想划分更小的小节…
最后可以加更详细的描述、示例代码等。
适用版本介绍:
1.5~ 指代适用于1.5以及之后的框架版本。
1.5~2.0 指代适用于1.5至2.0的框架版本,不适用于更早或者更新版本。需要注意这部分的定义代码已在更新版本弃用。
2.0 指代仅适用于2.0的框架版本,不适用于其它的框架版本。
更新内容
添加了适用版本说明。