1.6 KiB
1.6 KiB
DOC-015 区分确定规则、语法提案与未定边界
分类:语义与边界。级别:核心。本规则是项目写作约定,不是语言语义。
规则
状态集中记录,关键假设在使用点短注;编辑文档不能自动确认语言设计。
原因
既不能把草案写成稳定能力,也不能让每段说明淹没在同一免责声明中。
执行方法
- 全书入口说明设计稿范围,状态附录记录各主题确定程度。
- Product.get 和官方导入等影响代码合法性的假设在例子旁说明。
- 规则确定后同步主定义、示例、文法与状态;确认需要有明确用户决定。
改写对照
问题写法:为了让例子完整,给所有 class 宣称自动 get。
推荐做法:读取形式标为提案,并说明成员声明仍未定义。
以上是说明写作差异的项目例子,不新增语言能力。
验收
- 局部假设可见。
- 没有新增未经确认的强制规则。
- 同一状态声明不在每节重复。
具体应用
先读主要定义与规范状态,再检查全称词、默认值和示例成员。用户明确的新决定应落实准确范围,草案中仍未决定的签名、失败和权限不随之自动确定。
依据与边界
SRC-02。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。