WebStorm特殊注釋標記(TODO、FIXME、自定義注釋標記)

WebStorm IDE版本: Build #WS-192.6817.13 或者 2019.09.24構建版本

代碼里經常用到的注釋方式有以下幾種:

  • 單行注釋:// ......
  • 塊注釋:/* ...... */
  • 文檔注釋:/** ...... */

在不同的IDE中,這些注釋的樣式有所差異,有的樣式比較醒目,能引起人的注意;有的則比較暗淡,盡量不分散寫代碼的注意力。如果有需要的話,絕大部分IDE都能夠對各種注釋方式的樣式進行自定義(如修改字體、顏色、大小等)。請看下面的例子:

圖1 LayaAir 2.x IDE的注釋顏色

圖2 WebStorm IDE的注釋顏色(自定義后的顏色)

WebStorm特殊注釋標記TODO、FIXME

WebStorm中還有一些能幫助我們提高工作效率的注釋標記,例如TODO(大部分IDE都有類似的特殊標記)和FIXME。先看看例子:

圖3 WebStorm中TODO、FIX注釋標記

可以看到在雙斜杠之后添加TODOFIXME關鍵字都可以使注釋的樣式發生變化,這樣的特殊注釋可以跟一般的注釋區別開來,便于我們快速識別。當TODOFIXME注釋行下方的連續注釋行存在縮進時(tab空格),屬于同一塊標記注釋塊。(不僅雙斜杠注釋可以使用TODOFIXME,其他類型的注釋快也可以使用)

WebStorm中的TODO面板

如果僅僅是以特殊的標記方式,還不能很好的提高我們的工作效率,WebStorm還提供了專門的面板供我們索引項目中,或單文件中所有的特殊標記,通過點擊IDE下方TODO標簽Alt + 6)打開該面板,如下圖:

圖4 WebStorm中的TODO面板

  1. TODO面板標簽按鈕入口
  2. 索引范圍:
    • Project 整個項目
    • CurrentFile 當前文件
    • Scope Based 基于指定范圍(可以自定義范圍,這里不詳述)
  3. 索引列表,可以單擊跳轉到對應的注釋位置

WebStorm自定義TODO、FIXME的樣式

依次點擊File - Setting(或Ctrl + Alt + S),打開設置面板,并在設置面板中搜索“TODO”,見下圖:

圖5 在設置面板中搜索TODO

  1. 搜索“TODO
  2. 搜索“TODO”后的結果
  3. 樣式欄,WebStorm通過樣式欄提供的正則表達式來查詢特殊標記,默認會有todofixme的正則:\b(todo|fixme)\b.*
  4. 添加、刪除、編輯特殊標記正則表達式

選中列表中的樣式,點擊編輯按鈕打開編輯面板,編輯特殊標記的樣式,見下圖:


圖6 樣式編輯面板
  1. 修改正則表達式
  2. 選擇圖標
  3. 是否為正則表達式中的字符開啟大小寫敏感
  4. 樣式編輯區域,勾選 ‘Use color scheme TODO default colors’后,使用的是全局主題中的默認配色方案。如果要自定義樣式,先取消勾選。

點擊添加按鈕打開添加面板,跟上面的編輯面板雷同,可以添加自定義的特殊標記正則表達式,如自定義正則:\b(freeman)\b:.*,并使用自定義樣式,前景色選成藍色,見下圖:

圖7 添加自定義樣式

添加完成后看看效果:
圖8 自定義特殊標記

圖9 在TODO面板中的效果

WebStorm中的TODO面板中的篩選功能

再次打開設置面板,并在設置面板中搜索“TODO”,查看上圖5中,Filters欄目

圖10 篩選器

點擊右側的添加按鈕并添加篩選過濾,打開添加面板,新增名稱為@freeman的篩選器,并勾選對應的樣式,如下圖:
圖11 添加篩選器

  1. 篩選器名稱
  2. 篩選器對應的特殊標記

現在我們回到TODO面板,使用我們剛剛添加的篩選器:

圖12 使用篩選器

這樣就可以只看@freeman的特殊注釋了。

? WebStormw文檔參考地址

? WebStorm TODO comments

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,501評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,673評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,610評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,939評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,668評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,004評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,001評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,173評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,705評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,426評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,656評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,139評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,833評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,247評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,580評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,371評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,621評論 2 380

推薦閱讀更多精彩內容