Initial Dever 0.0.1
This commit is contained in:
commit
81233d098c
1479 files changed
+163782
No files matched your search
@@ -0,0 +1,21 @@
|
||||
# 文档写法
|
||||
|
||||
每个领域使用 README.md、doc/<主题>.md 和自动生成的 link.md。源码为 `.dever` 纯代码。
|
||||
|
||||
- README 用一段话介绍领域职责,并列出主题入口。
|
||||
- doc 按功能组织。二级标题绑定完整符号名,例如 `## manage.account.login`;同一函数只写一处,多分句共用。
|
||||
- 正文解释用途和必要规则,一般一两句。参数含义不清楚时再补说明,不复制签名、调用方或行号。
|
||||
- 不写占位描述、对话、修改日志或重复的模块介绍。说明必须符合当前源码。
|
||||
|
||||
VS Code 悬浮自动组合源码签名、主题说明和调用摘要;点击可查看源码与上下游。没有说明时仍显示真实签名,不需要在源码加注释。
|
||||
|
||||
修改代码后执行:
|
||||
|
||||
```sh
|
||||
dever inspect . --links
|
||||
dever inspect . --links --check
|
||||
```
|
||||
|
||||
link 展示调用顺序、分支和任务调度,保留完整关系,不手工改写。它是静态流程,实际请求和 Adapter 选择仍取决于输入及配置。
|
||||
|
||||
修改前读相关 README、主题与调用图,改完同步说明。检查器能发现失效符号、重复绑定和过期调用图,文字含义仍需对照实现。
|
||||
Reference in new issue
Block a user