language-servers/erg
1
0
Fork 0
mirror of https://github.com/erg-lang/erg.git synced 2025-09-29 20:34:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
erg/doc/zh_CN/dev_guide/doc_guideline.md
Cai Bingjun c78b053763 Updata commit hash
2022-10-15 16:54:42 +08:00

1.1 KiB
Raw Blame History

格式

badge

任何不符合以下规则的文件都将得到更正

  • 以某种语气写代码注释或内部文档
  • 向外部(普通用户)展示的文档应该越来越多地编写
  • 始终包含定义、含义或文档中首次出现的术语的链接
  • 仅对理解正文所必需的补充句子使用括号作为附加条件，对于理解正文不是必需的句子使用脚注1</ sup>
  • 如果文档内容过时，按照此方法更新

1 参见这里了解如何编写脚注。↩