Python · 3 分钟阅读
文件命名规范:`library` 目录
目录
docs/Python/library/ 目录里的文章是 知识速查手册,每篇对应一个具体
主题(函数、库、概念、语句)。为方便检索与维护,目录采用了一套统一的
三类命名约定。
1. 命名结构
文件名由 类型 + 主题 两部分组成,用下划线 _ 连接。
<type>_<topic>.md
│ │
│ └─ 主题(具体函数 / 库 / 概念)
│
└─ 类型(见下表)
没有
-也没有+。下划线让文件名在终端里也好复制粘贴。
2. 类型(<type>)
| 前缀 | 含义 | 例子 |
|---|---|---|
function_ |
内置函数 | function_any / function_input |
library_ |
标准库或第三方库 | library_argparse / library_regex |
statement_ |
Python 语句 | statement_import / statement_try_exception |
concept_ |
概念/特性 | concept_oop_class / concept_copy_deep_shallow |
Python_ |
综合性主题 | Python_List深入概述 / Python_面向对象编程_OOP |
历史遗留里还有少量
in_out.md/try_except.md没有前缀——它们是
“概念”类的特例,按内容归入concept_*即可。
3. 主题(<topic>)
- 小写、可加下划线:
lambda_map表示“lambda + map 一起讲”。 - 简明、可搜索:能让人在终端里
ls一眼看出在讲什么。 - 避免冗余:
function_reversed已经说明它是函数,别再写
function_reversed_function。
4. 中文主题的处理
Python_面向对象编程_OOP.md 这种命名在中文环境下仍然可读,但排序上中文会
聚在一起。如果你打算做大量中文主题,建议改成拼音或英文别名,比如:
Python_OOP_basic.mdPython_OOP_advanced.md
迁移后记得同步修改 front-matter 的 title 和 `
5. 新增一篇时该怎么命名?
按下面三步走:
- 确定类型:是函数?库?语句?还是概念?
- 写出主题:用最少的词概括内容。
- 拼起来:
{类型}_{主题}.md。
例:写一篇“
functools库”的文章 →library_functools.md;
写一篇“yield语句” →statement_yield.md;
写一篇“match/case” →concept_match.md。
6. 小结
<type>_<topic>.md是规范形式。- 类型从
function/library/statement/concept/Python_中选。 - 主题要小写、可搜索、避免冗余。
- 中文主题建议用拼音/英文别名,方便排序与检索。