【Flutter 學習筆記】如何使用單行與多行註解

【Flutter 學習筆記】線上課程教學影片：連結

【Flutter 學習筆記】系列文章目錄：連結

在程式開發的過程中，註解是一個不可或缺的工具。它不僅能幫助開發者快速了解程式碼的運算邏輯，還能在未來的維護中提供重要的參考。就像在程式碼中貼上便利貼，提醒未來的自己或他人該段程式碼的功能與用途。本文將介紹如何在 Dart 語言中使用單行與多行註解，並分享一些實用的技巧。

1. 單行註解

在 Dart 中，使用 // 來進行單行註解。這意味著註解後面的文字將不會被編譯或執行。舉個例子，假設我們有以下程式碼：

void main() {
  // print("哈囉, HKT 線上教室!");
}

2. 多行註解

當需要撰寫較長的說明或註解多行程式碼時，可以使用 /* 和 */ 來進行多行註解。這種註解方式不僅能提高程式碼的可讀性，還能方便其他開發者理解你的用途。以下是一個範例：

void main() {
  /*
  print("哈囉, HKT 線上教室!");
  print("哈囉, HKT 線上教室!");
  print("哈囉, HKT 線上教室!");
  */
}

在這段程式碼中，三行 print 函式都被包裹在多行註解中，因此這些內容將不會被執行。這樣的做法可以幫助我們在開發過程中暫時隱藏某些程式碼，或是新增詳細的註解說明，讓未來的維護工作更加輕鬆。

3. 註解的快捷鍵

在使用 Visual Studio Code 或 IntelliJ IDEA 進行開發時，熟悉註解的快捷鍵可以大幅提升工作效率。

Visual Studio Code

• 單行註解快捷鍵
• • Windows: 將游標停留在要註解的行上，然後按下 Ctrl + /
  • macOS: 將游標停留在要註解的行上，然後按下 Command + /
• 多行註解快捷鍵
• • Windows: 選取要註解的程式碼區塊，然後按下 Shift + Alt + A
  • macOS: 選取要註解的程式碼區塊，然後按下 Option + Shift + A

IntelliJ IDEA

• 單行註解快捷鍵
• • Windows: 將游標停留在要註解的行上，然後按下 Ctrl + /
  • macOS: 將游標停留在要註解的行上，然後按下 Command + /
• 多行註解快捷鍵
• • Windows: 選取要註解的程式碼區塊，然後按下 Ctrl + Shift + /
  • macOS: 選取要註解的程式碼區塊，然後按下 Command + Shift + /

結論

養成良好的註解習慣對於未來的程式維護將大有幫助。許多開發者常常自信地認為自己會記得當初寫程式的思路與原因，但實際上，當他們在一週或兩週後再次查看自己的程式碼時，往往需要花費大量時間去理解當初的邏輯。因此，與其等到事後再去回憶，不如在當下就為程式碼新增清晰的註解，這樣可以有效節省未來的時間與精力。希望這篇文章