Docs 知行杂记

用于提供公共文档收集

蛇形命名法（snake_case）

• 蛇形命名法是一种使用下划线 (_) 来分隔单词的命名方式。
• 所有字母都是小写的。
• 例子：linux_basics, system_administration, software_installation

蛇形命名法在 Unix/Linux 社区中非常流行，因为它与 shell 命令和系统环境变量的命名习惯保持一致。 这种风格易于阅读，尤其是在命令行界面中，因为它避免了大小写混淆，并且在输入时不需要切换大小写。

为什么采用蛇形命名？

命名方式 linux/command/rm_删除文件教程.md 是一个很好的折中方案，它结合了英文的开头 用于标识内容和功能，后面跟随中文描述用于提供更多的上下文信息。这种方式的好处在于：

• 明确性：文件名的开头 linux/command/rm_* 明确指出了这是关于 Linux 操作系统中 rm 命令的文档。
• 易读性：中文部分 /命令_删除文件或文件夹 提供了具体的文档内容描述，使得即使不熟悉英文的用户也能快速理解文档的主题。
• 搜索性：英文开头便于在支持英文搜索的环境中快速定位文档，而中文部分则便于中文用户在本地化环境中搜索和理解。

这种命名方式兼顾了国际化和多语言用户的需求，是一种比较通用和实用的方法。 只要确保在整个项目中保持一致的命名规则，就可以使得文档管理变得更加清晰和高效。 如果您想要进一步优化这种方式，可以考虑以下几点：

• 长度控制：尽量控制文件名的整体长度，过长的文件名可能会导致在终端或文件管理器中显示不完整。
• 关键词使用：在中文部分使用关键词，这样即使在英文搜索中也能通过这些关键词找到相关的中文文档。
• 规范分隔：使用统一的分隔符（如下划线）来分隔英文和中文，以及中文词汇，以保持文件名的清晰和一致性。

例如，您可以采用以下命名方式：

• linux/command/rm_删除文件教程.md
• linux/tool/vim_文本编辑指南.md
• linux/config/ssh_远程登录设置.md

这样的命名方式既包含了英文的关键词，又加入了中文描述，使得文件内容一目了然，同时也便于不同语言的用户理解和搜索。

注意事项

当文档或文件夹的命名包含中英文时，需要考虑的是如何保持命名的一致性、可读性和可搜索性。 以下是一些建议来规范命名方式：

1. 统一编码：确保所有的文档和文件夹名称都使用相同的编码，如UTF-8，这样可以避免中文字符在不同系统和应用程序之间出现乱码问题。
2. 分隔符：使用一致的分隔符来区分中英文单词。您可以继续使用下划线（_）作为分隔符，这在中文和英文中都很清晰。
3. 避免过长：尽量保持文件和文件夹的名称简短而清晰，避免过长的命名，尤其是在包含中文时，因为过长的中文名称可能会在文件列表中显示不完整。
4. 使用描述性名称：无论是中文还是英文，都应该使用描述性的词汇来命名，使得其他人即使不看内容也能大致了解文件或文件夹的主题。
5. 避免特殊字符：不要在文件或文件夹名称中使用特殊字符，如 *, ?, , &, /, \, |, :, ;, !, @, #, $, %, ^, &, *, (, ), , ~, > 和 < 等，因为这些字符在文件系统中具有特殊意义，或者在不同操作系统中可能不被支持。
6. 一致性：最重要的是在整个项目中保持命名风格的一致性。一旦确定了命名规则，就应该在整个文档集合中坚持使用。

记住，文件和文件夹的命名是为了方便人们理解和查找，所以在命名时应该考虑到易读性和易搜索性。