mirror of
https://github.com/erg-lang/erg.git
synced 2025-09-29 12:24:45 +00:00
15 lines
No EOL
1.1 KiB
Markdown
15 lines
No EOL
1.1 KiB
Markdown
# 格式
|
|
|
|
[](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=a9d45b743cc655543e0d7f586426499091cead3d)
|
|
|
|
任何不符合以下规则的文件都将得到更正
|
|
|
|
* 以某种语气写代码注释或内部文档
|
|
* 向外部(普通用户)展示的文档应该越来越多地编写
|
|
* 始终包含定义、含义或文档中首次出现的术语的链接
|
|
* 仅对理解正文所必需的补充句子使用括号作为附加条件，对于理解正文不是必需的句子使用脚注[<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> |