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工程