iT邦幫忙

2024 iThome 鐵人賽

DAY 23
1
IT 管理

30天從版控到code review的實踐指南系列 第 23

Day 23. Code Review 可維護性與易讀性:Better Comments 輔助工具篇

  • 分享至 

  • xImage
  •  

今天要介紹 VSCode 中,可讓註解更清楚的輔助 extension- Better Comments

如何使用 Better Comments 提高程式碼易讀性?


  • Better Comments 安裝步驟:

    1. 打開 VSCode
    2. 到 Extensions
    3. install Better Comments

    ![Day 23. better-comments截圖.png](https://prod-files-secure.s3.us-west-https://ithelp.ithome.com.tw/upload/images/20241007/20169483uDfAijbLQU.png

  • 設定 Settings.json

    VS Code 設定:File > Preferences > SettingsCtrl+, > 按右上 Open Settings(UI)> 加入以下設定(參考官網

    "better-comments.tags": [
        {
          "tag": "!",
          "color": "#FF2D00",
          "strikethrough": false,
          "underline": false,
          "backgroundColor": "transparent",
          "bold": false,
          "italic": false
        },
        {
          "tag": "?",
          "color": "#3498DB",
          "strikethrough": false,
          "underline": false,
          "backgroundColor": "transparent",
          "bold": false,
          "italic": false
        },
        {
          "tag": "//",
          "color": "#474747",
          "strikethrough": true,
          "underline": false,
          "backgroundColor": "transparent",
          "bold": false,
          "italic": false
        },
        {
          "tag": "todo",
          "color": "#FF8C00",
          "strikethrough": false,
          "underline": false,
          "backgroundColor": "transparent",
          "bold": false,
          "italic": false
        },
        {
          "tag": "*",
          "color": "#98C379",
          "strikethrough": false,
          "underline": false,
          "backgroundColor": "transparent",
          "bold": false,
          "italic": false
        }
      ]
    
  • 成果

    依據設定檔,可依註解類型,選擇不同的符號與顏色。

https://ithelp.ithome.com.tw/upload/images/20241007/201694839FMvaGZj6J.png

Summary


在撰寫註解時,養成對註解進行分類的習慣,不僅能幫助自己,也能提醒團隊協作者關注需要特別注意的重點。透過這樣的分類,團隊成員可以更快速地理解程式碼意圖與邏輯,進而提升協作效率。此外,每個人都可以根據自己的偏好,在設定檔中自訂顏色與分類標籤,使程式碼更加清晰易讀,強化團隊溝通與專案管理的效果。


上一篇
Day 22. Code Review 可維護性與易讀性:註解撰寫規則篇
下一篇
Day 24. Code Review 可維護性與易讀性:Todo Tree 輔助工具篇
系列文
30天從版控到code review的實踐指南30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言