andriod studio TODO 功能分享

前言

寫程式的時候,可能某個 function 的演算法寫得不夠簡潔.但是手頭上還有其他工作,所以暫時放下等有時間再來優化,這時候就可以暫時做一個註記,類似便條紙的功能提醒自己,或是目前功能已經完成到一個段落,需要等全部人都完成工作才能進行測試,那麼也可以加入註記.

要做註記時,我們就可以使用 Android Studio 內建的 TODO 功能來做紀錄,只要打開 TODO List 清單就可以檢查,手中還有什麼地方需要去完成.當完成後再重清單中移除.

介紹

1. 如何在程式碼中加入 TODO

輸入 todo,就會跳出提示

點選 Tab 鍵 就會跳出 TODO 跟當下的日期

可以在日期後,輸入準備要做的事項

2. FIXME
除了基本的 TODO 之外 Default 還提供一個關鍵字 FIXME,可以用來表示修正的項目,與 TODO 類似只是標籤不同,最後都會顯示在列表中,方便查看時區隔不同的標籤.

輸入 fixem

顯示日期,可以在日期後輸入想要紀錄的訊息

3. 如何開啟查看 TODO 的 List

View -> Tool Windows -> TODO

Android Studio 側邊或底部欄位

列表中就會顯示,總共有幾個 TODO 跟 檔案的 folder 所在路徑

4. 訊息雜亂,如何篩選出想要查看的標籤(區隔開 TODO 跟 FIXME)

TODO 跟 FIXME 混在一起,點選紅框處按鈕

點選 Edit Filters

顯示 TODO 窗口,紅框處顯示小括號把 FIXME 跟 TODO 綁在一起

點選+,輸入fixme
注意事項:開頭 \b 跟結尾 \b.*是需要輸入的,中間是篩選的標籤名稱

此時 Patterns 已產生完成,Case Sensitive 沒有打勾選,不區分大小寫

點選 Filter +,勾選 fixme 並輸入 Filter name 即可

Filters 完成新增
成果 
點選篩選按鈕,點選 FIXME

顯示篩選結果

5. 如果想要自定義 TODO,比方說專案裡有東西要指定給其他團隊 ASSIGNOTHER 或有項目需要暫時擱置 WAIT,那麼可以到 Preferense 內設定 Patterns 或延續剛剛的步驟加入想要自定義的 TODO.

點選 Patterns 加入

加入 assignother 沒有勾選 case Sensitive 區分大小寫

wait,注意開開頭跟結尾 \b, \b.* 的設定不要輸入錯誤

設定完成的結果

程式碼顯示結果

TODO list 顯示結果

6. 新增的 Patterns 一樣可以加入篩選

勾選後,給定名稱就可以使用

7. 新增的 Patterns 沒有辦法快速輸入,按 Tab 鍵就把內容補全,需要自行輸入很耗費時間,可以使用 Live Template來快速完成.以下不會詳細說明,只會顯示設定步驟.

首先進入 Preferences

選擇 Live Template -> Android Comments

可以看到 TODO 跟 FIXME

接著要加入 assignother 跟 wait 兩個標籤

點選 +號,Live Template


Abbreviation : 是輸入指定的字就會跳出提示,這邊設定 as
Description : 提示時會顯示的內容,這邊輸入 把工作指向其他團隊
Template text : 輸入 as 點選 Tab 之後會顯示的內容
特別注意 :
$符號包住的字元是系統可以幫你產生的內容,這邊設定 $DATE$
$ 符號產生的內容是會變動的,如路徑或檔名等,可以解決 Template text 只能產生固定的內容


1. Android Comments 已經顯示了設定
2. 點選 Edit variables 編輯 DATE 變數

Expression 下拉選單選擇 date() 由系統產生,也可以選擇其他的系統 function

勾選 skip if defined 後點選 ok

勾選 Reformat 以及定義 Define

點選 Everywhere,最後按OK

沒有按 OK,不會完成設定,重開後消失

按照重複步驟完成 WAIT 的設定


實測結果
WAIT:


ASSIGNOTHER:


TODO List 也都可以查看到


後記
如果這篇文章對你有幫助,可以幫忙分享給還在學習路上的人,文章中內容如果有錯誤,告知後會進行修正,如果有什麼問題或建議也可以留言告訴我.

END



留言

熱門文章

2021申請 Android Developer 開發者帳號及上架步驟

Generate Signed Bundle / APK(s) & Bundle Tool 基本使用 & .aab安裝方式

40 個可以改變寫程式技巧的秘訣