# 格式

[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3Ddoc/EN/dev_guide/doc_guideline.md%26commit_hash%3Dd15cbbf7b33df0f78a575cff9679d84c36ea3ab1)](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/doc_guideline.md&commit_hash=d15cbbf7b33df0f78a575cff9679d84c36ea3ab1)

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

* 以某种语气写代码注释或内部文档。
* 向外部(普通用户)展示的文档应该越来越多地编写。
* 始终包含定义、含义或文档中首次出现的术语的链接。
* 仅对理解正文所必需的补充句子使用括号作为附加条件，对于理解正文不是必需的句子使用脚注[<sup id="f1">1</sup>]( #1)。
* 如果文档内容过时，按照【此方法】更新(https://github.com/erg-lang/erg/issues/48#issuecomment-1218247362)。

---

<span id="1" style="font-size:x-small"><sup>1</sup> 参见这里了解如何编写脚注。[↩](#f1)</span>