使用CODEX为你的项目编制一套代码库目录/索引

灵感来源

本文来自一片项目重构文章的启发，该文章作者一整年经历了 3 个代码十分混乱的项目，最大的收获就是摸索出了一个梳理烂代码的最佳实践——CODEX。

原文路径：一个技术总监的忠告：精通那么多技术为何还是做不好一个项目？.

文章作者的本意是重构项目时便于梳理项目结构提出的一个活的源代码索引。

然而对于一些实践，借鉴了前者的经验，整理了一套基于idea的CODEX，可以在编写代码的时候按照规范将注释以特定形式输入，达成一个自动生成索引的功能，方便定位代码功能与位置。

增加索引标签

首先，我们可以为索引增加一个特定的标签，类似于todo，并且统一约定这个标签，随着开发者将注释随着代码进行提交的时候，将标签也会一同带上，这样另一个人在拉取代码的时候就会很清楚的了解到这个项目结构目录。

然后基于每个功能的分解步骤进行注释的编写

然后查看下方的todo列表

过滤todo信息


然后就可以看到完整的codex项目索引了。

这种方式可以快速的查询到问题，一方面可以使新人快速了解各个结构之间的关系和功能分布，另一方面可以在出现问题的时候快速定位代码位置，便于修改。

生成markdown

进一步的，如果在 CODEX 中添加 Markdown 关键字，甚至可以将导出的 CODEX 简单加工后，变成一张业务逻辑的 Sequence 序列图，如下所示。

结合业务逻辑，我们再来看一下，只需将每一步操作记录下来，简单的处理下便可得到一个项目结构图。

以上图为例，我们将必要注释记录清楚稍作加工便可形成下图所示图形。

这样就可以极大的方便了我们梳理项目结构和接手新项目的学习成本。