Skip to content

Commit 2718203

Browse files
authored
Fix formatting of flags description in documentation
1 parent a72a854 commit 2718203

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Reports/2025/#361-2025.12.29.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
* 帮助和文档:默认运行无参数时显示简洁的帮助,`-h/--help` 对应完整的帮助说明。
4848
* 输出设计:人类可读最重要,如果为了人类可读破坏了机器可读,可以增加 `--plain` 参数输出机器可读内容,这有利于 grep、awk工具的集成
4949
* 错误处理:避免冗余输出,核心错误应该放在末尾
50-
* 参数和标志:优先使用 `flags`,而不是依赖位置读参数;所有 `flags` 都提供短格式和长格式两种(`-h/--help`);危险操作增加一个保护措施:输入名称、--force 标志等
50+
* 参数和标志:优先使用 `flags`,而不是依赖位置读参数;所有 `flags` 都提供短格式和长格式两种(`-h/--help`);危险操作增加一个保护措施:输入名称、`--force` 标志等
5151
* 健壮性与兼容性:及时响应用户的输入(100ms以内),如果流程耗时增加进度反馈(进度条)
5252
* 环境变量:避免占用 POSIX 标准变量;本地用 `.env` 管理但不应把 `.env` 当做配置文件;不要使用环境变量存储密钥等重要信息,这样很容易泄漏,推荐通过文件或密钥管理服务
5353

0 commit comments

Comments
 (0)