文档基础样式

文档命名规范

工具使用

包含以下关键字：

[环境][工具名称]

例如：

功能实现

包含以下关键字：

[工具名称][实现的功能]

例如：

错误记录

包含以下关键字：

[环境/使用工具名称][错误提示信息]

例如：

其他

待定….

表示类

[类名]

表示方法

[类名]#[方法名]

方法名不带()，并用青色 （HEX ：#00627A；RGB(0,98,122)）进行标注。

表示属性

[类名]$[属性名]

属性名称用青色 （HEX ：#00627A；RGB(0,98,122)）进行标注。

表示类与类之间的关系

继承

[子类名称]->[父类名称]

父类名字使用青色 （HEX ：#00627A；RGB(0,98,122)）进行标注。

实现

[类名称]-[接口名称]

接口名称使用青色 （HEX ：#00627A；RGB(0,98,122)）进行标注。

内部类

[外部类名称]>[内部类名称]

外部类名字使用青色 （HEX ：#00627A；RGB(0,98,122)）进行标注。

动作

进入

表示进入一个方法，用“进入”作为开头动词：

并将“进入”两字加粗，与其后的内容中间空一格。

命名规范

参考文献

表示写作所引用、使用、参考的内容，以下面的格式来进行标注：

每个参考资料的标题大纲级别为2级，url 字号大小为15，这样方便在大纲目录中直接查看参看文档信息。

基于语雀的标注

背景颜色

黄色

重点信息

不同语言之间的特性

Java

其他

参考文档