为保证清晰、统一的编辑与阅读体验,在本知识库中编写文档时,请遵循以下规范:

1.标题命名

[类别] 类名-类概况
如:
[Util] AntPathMatcher-URLs字符串匹配类

2.文档结构

  • 类概况(位置、实现接口、继承类、作用)
  • 一、效果
  • 二、API
  • 三、总结
  • 四、补充

注意:结构目录使用标题格式,方便生成大纲目录

3.文本格式

  • 引入块代码时使用 ``` + Enter 引入块代码格式,如:

    1. Hello World!
  • 引入外部网站使用插入链接方式,如:Spring源码学习

  • 引用、标注性质的文本使用斜体+浅色格式,如:这是一行标注

补充:利用模板功能快速生成标准结构的文档骨架

1.点击新建-选择模板
image.png
image.png

2.效果
image.png