Android Studio & IDEA工程文檔編寫

不知道大家有沒有這樣的需求：項目工程想規範化，有一些關鍵類的說明文檔;或者剛接手了一個不堪入目，沒有注釋的工程，每次找一些關鍵類的時候，總是靠記憶或者其他筆記去打開。

今天在梳理接手的工程時候，想讓寫一個ReadMe文檔，并且可以跳轉打開一些檔案，比如某些關鍵類。先看效果：

這個效果很大地滿足了我的需求。為了達到這個效果，需要具備2個知識點：

1. Markdown文法: 不了解同學的可以百度下，不到10分鐘你就可以成為一個Markdown入門選手
2. 跳轉檔案連結的配置

Markdown配置與文法

1. 安裝Markdown插件：Preferences→Plugins->Marketplace→安裝Markdown插件，重新開機Android Studio
2. 在工程目錄中适當的位置建立以"README.md"檔案(以md結尾的Markdown檔案即可)
3. 複制下面這段md，按住Ctrl + 滑鼠左鍵 or Command + 滑鼠左鍵，即可跳轉打開指定的檔案，包括檔案夾

[測試](build.gradle)

Markdown基礎文法：

1. #代表着标題，幾個#代表這個幾級的标題

2. [顯示的文本](跳轉的連結)

   ：中拓号用于顯示預覽的文本，括号内是連結位址，可以網址，也可以是本文中的檔案位址

上文動圖，可以參考本人GitHub工程

檔案引用路徑的生成

上面動圖使用到的檔案路徑[app/src/main/java/com/ben/template/XApplication.kt]，有一定的規則：必須是從項目的根目錄作為起始路徑，而不是在電腦系統中的絕對路徑。是以這裡要使用一個指令：Path From Respository Root，可以通過以下2個方式去找到

1. 菜單欄→Edit→Copy找到
2. 設定項Preferences→Keymap→直接搜尋并添加快捷鍵

其他

1. Markdown推薦編輯器：馬克飛象 這個編輯器是我入坑Markdown以來一直在用的，渲染效果好，可以導出pdf、md、html。
2. Android Studio上還可以通過Favorites面闆來儲存需要的檔案，也可以通過書簽Bookmarks來儲存，有相應的快捷鍵

GitHub工程