文檔(代碼註釋)是編碼的一個重要方面,它可以降低客戶端使用 API 的複雜度,也有助於項目維護。在 Go 語言中,我們應該遵循一些規則使得我們的代碼更地道。下面一起來看看這些規則。每個可導出的元素必須添加文檔說明,無論是結構體、接口、函數還是其他元素。如果它被導出,則必須有文檔說明。通用的文檔說明是添加註釋,註釋前以元素名稱開始,像下面這樣。// Customer is a customer re ⌘ Read more
文檔(代碼註釋)是編碼的一個重要方面,它可以降低客戶端使用 API 的複雜度,也有助於項目維護。在 Go 語言中,我們應該遵循一些規則使得我們的代碼更地道。下面一起來看看這些規則。每個可導出的元素必須添加文檔說明,無論是結構體、接口、函數還是其他元素。如果它被導出,則必須有文檔說明。通用的文檔說明是添加註釋,註釋前以元素名稱開始,像下面這樣。// Customer is a customer re ⌘ Read more