跳转到内容

文件组织

本页用于记录此文档源代码文件的放置和归类方式,用于选择拆分和合并文件的原则,与一个文档页面中的内容组成。

这些规则并不是完全强制性的,我们有可能在理解和实现文件组织目的的情况下违反这里部分或全部的规则,只要开发者认为这是有益的。

参照 Starlight 的项目组织方式,我们使用了如下一级子目录:

  • start — 此文档的导引内容

  • dev — Vitium 开发流程的参考

  • app — 关于 Vitium 作为一个 Web 2 应用程序的需求

  • game — Vitium 的游戏设定

  • mod — Vitium 的第三方模组标准

  • client — 关于那些仅适用于 Vitium 客户端的需求

  • server — 关于那些仅适用于 Vitium 服务端的需求

  • meta — 有关于此文档自身的内容

我们建议尽可能在需要时使用更多层级的目录来保持清晰。

此文档中的绝大多数文件都是以 有且仅有 一个需求作为主题的。这既包括需求本身,也包括需求的实现。

对于这样的文件,如果有需要记录需求的实现细节,我们在文件末尾添加一个名为「实现」的二级标题项,并用 Markdown 分割线与上文对需求的描述分开。