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

更新 發佈閱讀 4 分鐘
vocus|新世代的創作平台
【Flutter 學習筆記】線上課程教學影片:連結
【Flutter 學習筆記】系列文章目錄:連結

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

1. 單行註解

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

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

在這段程式碼中,print 函式被註解掉,因此這行程式碼不會被執行,輸出資訊區中也不會顯示任何內容。這種方式非常適合用來暫時隱藏某些程式碼,或是為特定行程式碼提供簡短的說明。

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 + /

結論

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

留言
avatar-img
HKT實驗室
31會員
278內容數
哈囉!歡迎光臨我的沙龍!我是 KT,一位對應用程式開發充滿熱情的開發者。在這個專屬空間,我將與您分享我在應用開發領域的深入學習心得和豐富的實戰經驗。如果您對應用程式開發技術同樣充滿好奇,渴望不斷探索新知,歡迎成為我們的會員,一起在應用程式開發的旅途上,探索更深層次的技術世界,享受學習的樂趣。
HKT實驗室的其他內容
2024/11/18
在 Dart 程式語言中,除了位置參數和預設參數值外,具名參數的使用讓函式的呼叫變得更加清晰且易於理解。特別是在參數較多的情況下,具名參數的優勢尤為明顯。本篇文章將深入探討如何定義和使用具名參數,並透過實際範例來加深讀者的理解。
Thumbnail
2024/11/18
在 Dart 程式語言中,除了位置參數和預設參數值外,具名參數的使用讓函式的呼叫變得更加清晰且易於理解。特別是在參數較多的情況下,具名參數的優勢尤為明顯。本篇文章將深入探討如何定義和使用具名參數,並透過實際範例來加深讀者的理解。
Thumbnail
2024/11/17
在 Dart 程式語言中,函式不僅可以接收參數,還能為這些參數設定預設值。這樣的設計使得函式的呼叫更加靈活,並且簡化了程式碼的撰寫。本文將深入探討如何定義具有預設參數值的函式,並透過實際範例來加深理解。
Thumbnail
2024/11/17
在 Dart 程式語言中,函式不僅可以接收參數,還能為這些參數設定預設值。這樣的設計使得函式的呼叫更加靈活,並且簡化了程式碼的撰寫。本文將深入探討如何定義具有預設參數值的函式,並透過實際範例來加深理解。
Thumbnail
2024/11/16
在 Dart 程式語言中,函式不僅能執行特定任務,還能回傳值,這使得函式在程式中更具彈性和重用性。本篇文章將深入探討如何定義一個具有回傳值的函式,並透過實際範例來幫助大家理解其結構與用途。
Thumbnail
2024/11/16
在 Dart 程式語言中,函式不僅能執行特定任務,還能回傳值,這使得函式在程式中更具彈性和重用性。本篇文章將深入探討如何定義一個具有回傳值的函式,並透過實際範例來幫助大家理解其結構與用途。
Thumbnail
看更多
你可能也想看
Thumbnail
本文介紹了在 Dart 語言中使用單行和多行註解的方式及其作用。同時分享了在 Visual Studio Code 和 IntelliJ IDEA 中進行註解的快捷鍵。結論指出養成良好註解習慣對未來程式維護大有裨益,應及時為程式碼添加清晰註解。
Thumbnail
本文介紹了在 Dart 語言中使用單行和多行註解的方式及其作用。同時分享了在 Visual Studio Code 和 IntelliJ IDEA 中進行註解的快捷鍵。結論指出養成良好註解習慣對未來程式維護大有裨益,應及時為程式碼添加清晰註解。
Thumbnail
本文分析導演巴里・柯斯基(Barrie Kosky)如何運用極簡的舞臺配置,將布萊希特(Bertolt Brecht)的「疏離效果」轉化為視覺奇觀與黑色幽默,探討《三便士歌劇》在當代劇場中的新詮釋,並藉由舞臺、燈光、服裝、音樂等多方面,分析該作如何在保留批判核心的同時,觸及觀眾的觀看位置與人性幽微。
Thumbnail
本文分析導演巴里・柯斯基(Barrie Kosky)如何運用極簡的舞臺配置,將布萊希特(Bertolt Brecht)的「疏離效果」轉化為視覺奇觀與黑色幽默,探討《三便士歌劇》在當代劇場中的新詮釋,並藉由舞臺、燈光、服裝、音樂等多方面,分析該作如何在保留批判核心的同時,觸及觀眾的觀看位置與人性幽微。
Thumbnail
在本篇教學中,我們介紹了 Flutter 中的 Row 和 Column 佈局容器,並探討了它們的基本用法及進階技巧。此外,我們還提到如何使用快捷鍵來格式化程式碼,以提升可讀性。
Thumbnail
在本篇教學中,我們介紹了 Flutter 中的 Row 和 Column 佈局容器,並探討了它們的基本用法及進階技巧。此外,我們還提到如何使用快捷鍵來格式化程式碼,以提升可讀性。
Thumbnail
本文介紹了 Dart 中具有參數的函式。具有參數的函式允許靈活地處理不同輸入,增強程式碼的模組化和可重用性。透過範例說明,讀者能夠理解如何定義和使用這些函式,並掌握進階概念以提升程式設計能力。
Thumbnail
本文介紹了 Dart 中具有參數的函式。具有參數的函式允許靈活地處理不同輸入,增強程式碼的模組化和可重用性。透過範例說明,讀者能夠理解如何定義和使用這些函式,並掌握進階概念以提升程式設計能力。
Thumbnail
這是一場修復文化與重建精神的儀式,觀眾不需要完全看懂《遊林驚夢:巧遇Hagay》,但你能感受心與土地團聚的渴望,也不急著在此處釐清或定義什麼,但你的在場感受,就是一條線索,關於如何找著自己的路徑、自己的聲音。
Thumbnail
這是一場修復文化與重建精神的儀式,觀眾不需要完全看懂《遊林驚夢:巧遇Hagay》,但你能感受心與土地團聚的渴望,也不急著在此處釐清或定義什麼,但你的在場感受,就是一條線索,關於如何找著自己的路徑、自己的聲音。
Thumbnail
在這篇文章中,我們介紹了 Dart 中的字串資料類型,包括如何使用單引號和雙引號定義字串、如何建立多行字串,以及如何使用字串插入。字串資料型態在處理文字、顯示訊息或進行字串操作時非常實用,開發者可以根據需求靈活運用這些特性。
Thumbnail
在這篇文章中,我們介紹了 Dart 中的字串資料類型,包括如何使用單引號和雙引號定義字串、如何建立多行字串,以及如何使用字串插入。字串資料型態在處理文字、顯示訊息或進行字串操作時非常實用,開發者可以根據需求靈活運用這些特性。
Thumbnail
本文介紹如何建立第一個 Flutter 應用程式。如何在 Visual Studio Code 中建立專案,包括專案類型選擇、存放位置設定等。還介紹了在 iOS、Android 模擬器、真實設備及建立 Web、桌面應用程式執行的方法
Thumbnail
本文介紹如何建立第一個 Flutter 應用程式。如何在 Visual Studio Code 中建立專案,包括專案類型選擇、存放位置設定等。還介紹了在 iOS、Android 模擬器、真實設備及建立 Web、桌面應用程式執行的方法
Thumbnail
5 月將於臺北表演藝術中心映演的「2026 北藝嚴選」《海妲・蓋柏樂》,由臺灣劇團「晃晃跨幅町」製作,本文將以從舞台符號、聲音與表演調度切入,討論海妲・蓋柏樂在父權社會結構下的困境,並結合榮格心理學與馮.法蘭茲對「阿尼姆斯」與「永恆少年」原型的分析,理解女人何以走向精神性的操控、毀滅與死亡。
Thumbnail
5 月將於臺北表演藝術中心映演的「2026 北藝嚴選」《海妲・蓋柏樂》,由臺灣劇團「晃晃跨幅町」製作,本文將以從舞台符號、聲音與表演調度切入,討論海妲・蓋柏樂在父權社會結構下的困境,並結合榮格心理學與馮.法蘭茲對「阿尼姆斯」與「永恆少年」原型的分析,理解女人何以走向精神性的操控、毀滅與死亡。
Thumbnail
背景:從冷門配角到市場主線,算力與電力被重新定價   小P從2008進入股市,每一個時期的投資亮點都不同,記得2009蘋果手機剛上市,當時蘋果只要在媒體上提到哪一間供應鏈,隔天股價就有驚人的表現,當時光學鏡頭非常熱門,因為手機第一次搭上鏡頭可以拍照,也造就傳統相機廠的殞落,如今手機已經全面普及,題
Thumbnail
背景:從冷門配角到市場主線,算力與電力被重新定價   小P從2008進入股市,每一個時期的投資亮點都不同,記得2009蘋果手機剛上市,當時蘋果只要在媒體上提到哪一間供應鏈,隔天股價就有驚人的表現,當時光學鏡頭非常熱門,因為手機第一次搭上鏡頭可以拍照,也造就傳統相機廠的殞落,如今手機已經全面普及,題
Thumbnail
程式註解在程式開發中扮演重要角色,像是附上便利貼般,幫助開發者快速理解程式碼功能。
Thumbnail
程式註解在程式開發中扮演重要角色,像是附上便利貼般,幫助開發者快速理解程式碼功能。
Thumbnail
從今天開始往後的的內容會有許多的「註解」,程式不會執行被註解的內容,註解只是方便開發者辨識。JS內的註解主要有兩種。單行註解是在程式碼前方加上//,可以透過快捷鍵cmd(ctrl) + / 完成。多行註解則是用/* 及 */前後包夾要註解的內容。 轉換環境 從上個單元的經驗,有些人可能會發現
Thumbnail
從今天開始往後的的內容會有許多的「註解」,程式不會執行被註解的內容,註解只是方便開發者辨識。JS內的註解主要有兩種。單行註解是在程式碼前方加上//,可以透過快捷鍵cmd(ctrl) + / 完成。多行註解則是用/* 及 */前後包夾要註解的內容。 轉換環境 從上個單元的經驗,有些人可能會發現
追蹤感興趣的內容從 Google News 追蹤更多 vocus 的最新精選內容追蹤 Google News