在大多數情況下，您并不是唯一在同一項目或代碼庫上工作的人。這意味著其他人可能也會閱讀您的代碼并且必須理解它。

所以，您應該編寫代碼注釋來幫助其他開發人員去理解你所寫的代碼。描述函數、函數背后的推理及其輸入和輸出的代碼注釋將加快其他開發人員的學習過程。特別是對于初級開發人員，這些信息在學習代碼時會派上用場。

讓我們來看看不同類型的代碼注釋。

1. 文檔注釋——這些注釋的主要目的是快速闡明文件或組件的用途。您可以在 `index` 文件的頂部寫一個代碼注釋來解釋組件的作用，而不是閱讀組件的整個代碼來了解它的作用。

2. 函數注釋——函數注釋是最有用的注釋類型，可以自動生成多種語言。它們描述了函數的用途、它接受的參數以及它生成的輸出。通常只描述公共函數就足夠了，因為使用您的代碼的開發人員不會與私有函數交互。

?3.邏輯注釋 - 邏輯注釋是函數內的注釋，用于闡明復雜的代碼路徑。

最重要的是，邏輯注釋通常會提供很多詳細的信息。詳細程度會造成更多混亂并降低代碼的可讀性。

代碼注釋：4 個最佳實踐

這是代碼注釋的四個最佳實踐的列表。

1.利用代碼注釋或標簽

許多編程語言定義了代碼注釋標準。 Java 使用 Javadoc，而 JavaScript 使用許多文檔生成工具支持的 JSDoc 代碼注釋系統。

您應該做好以下代碼標記：

@desc - 為您的函數寫下描述

@param - 描述函數接受的所有輸入參數。確保定義輸入類型。

@returns - 描述返回的輸出。確保定義輸出類型。

@throws - 描述函數可以拋出的錯誤類型

@example - 包含一個或多個顯示輸入和預期輸出的示例。

2. 寫下你為什么要做某事

許多開發人員使用注釋來描述他們的代碼正在做什么。這不一定是錯誤的。但是，不要忘記包括創建特定功能或組件的原因。此信息稱為上下文。上下文對于讓開發人員更深入地了解功能或組件背后的設計決策至關重要。當其他開發人員想要對您的功能或組件進行更改時，此上下文至關重要。

您經常會看到在函數描述中使用函數名稱的代碼注釋。

3. 不要參考其他文件或評論

參考闡明功能或組件的其他代碼注釋或內部文檔并不是一個好主意。如果開發者想快速掃描代碼以獲得更好的理解，代碼注釋應該清晰。

如果你認為你需要添加一個文檔來闡明代碼的目的，這是錯誤代碼的危險信號。

4. 在寫代碼的同時寫注釋

在編寫代碼的同時編寫注釋聽起來是很理所應當的，但許多開發人員違反了這條規則。

您可能會忘記在這種情況下編寫的部分邏輯，從而導致代碼注釋質量降低。如果您在單個拉取請求上工作多天，最好在完成功能或模塊時寫注釋。

代碼評論是一門藝術嗎？

如果您關心代碼質量，請花時間編寫有意義的代碼注釋。這需要一些練習，但可以很快學會。要記住的關鍵概念是在代碼注釋中添加上下文。描述你創建代碼背后的原因，而不僅僅是表面的信息。

網站題目：如何編寫有意義的代碼注釋
新聞來源：http://vcdvsql.cn/article46/egoshg.html

成都網站建設公司_創新互聯，為您提供網站導航、網站設計、網站營銷、服務器托管、搜索引擎優化、手機網站建設

廣告

聲明：本網站發布的內容（圖片、視頻和文字）以用戶投稿、用戶轉載內容為主，如果涉及侵權請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網站立場，如需處理請聯系客服。電話：028-86922220；郵箱：631063699@qq.com。內容未經允許不得轉載，或轉載時需注明來源： 創新互聯