mirror of
https://github.com/erg-lang/erg.git
synced 2025-10-01 05:11:09 +00:00
1.1 KiB
1.1 KiB
格式
任何不符合以下规则的文件都将得到更正。
- 以某种语气写代码注释或内部文档。
- 向外部(普通用户)展示的文档应该越来越多地编写。
- 始终包含定义、含义或文档中首次出现的术语的链接。
- 仅对理解正文所必需的补充句子使用括号作为附加条件，对于理解正文不是必需的句子使用脚注1。
- 如果文档内容过时，按照【此方法】更新(https://github.com/erg-lang/erg/issues/48#issuecomment-1218247362)。
1 参见这里了解如何编写脚注。↩