靈感來源

本文來自一片項目重構文章的啟發，該文章作者一整年經歷了 3 個代碼十分混亂的項目，最大的收獲就是摸索出了一個梳理爛代碼的最佳實踐——CODEX。

原文路徑：一個技術總監的忠告：精通那么多技術為何還是做不好一個項目？.

文章作者的本意是重構項目時便于梳理項目結構提出的一個活的源代碼索引。

然而對于一些實踐，借鑒了前者的經驗，整理了一套基于idea的CODEX，可以在編寫代碼的時候按照規范將注釋以特定形式輸入，達成一個自動生成索引的功能，方便定位代碼功能與位置。

增加索引標簽

首先，我們可以為索引增加一個特定的標簽，類似于todo，并且統一約定這個標簽，隨著開發者將注釋隨著代碼進行提交的時候，將標簽也會一同帶上，這樣另一個人在拉取代碼的時候就會很清楚的了解到這個項目結構目錄。

然后基于每個功能的分解步驟進行注釋的編寫

然后查看下方的todo列表

過濾todo信息


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

目錄的編制？這種方式可以快速的查詢到問題，一方面可以使新人快速了解各個結構之間的關系和功能分布，另一方面可以在出現問題的時候快速定位代碼位置，便于修改。

生成markdown

進一步的，如果在 CODEX 中添加 Markdown 關鍵字，甚至可以將導出的 CODEX 簡單加工后，變成一張業務邏輯的 Sequence 序列圖，如下所示。

結合業務邏輯，我們再來看一下，只需將每一步操作記錄下來，簡單的處理下便可得到一個項目結構圖。

以上圖為例，我們將必要注釋記錄清楚稍作加工便可形成下圖所示圖形。

這樣就可以極大的方便了我們梳理項目結構和接手新項目的學習成本。