我應該寫評論嗎?

關於註釋代碼和以正確方式註釋的想法

人們經常被告知評論非常重要。註釋是編程的重要組成部分。作為初學者,很難判斷和確定您應該添加多少條評論以及在評論中寫些什麼!

這不是一成不變的事情,每個人似乎都有不同和相反的看法,因此這使您陷入了充滿不安全感的困境。

這是我的思路:您應該寫盡可能少的評論來解釋您的決定

讓我們對此進行剖析。

您的代碼應盡可能自我解釋。

諸如JavaScript或Python之類的高級語言都具有很高的可讀性。如果正確命名變量和方法,您幾乎可以大聲閱讀該代碼,並認為它是純英語的。

有些事情需要更多的思考,但是即使代碼有些複雜,只要程序員可以閱讀並確定100%的代碼功能,它也不需要註釋。

當您需要解釋以下內容時,您需要發表評論為什麼特定指令或塊。不是什麼,應該從代碼中推斷出來。我們之所以將其稱為高級是因為它是我們可以考慮的代碼。它不是機器語言或彙編語言,這很難理解。

您的某些代碼塊將需要註釋以解釋其他代碼,或者甚至你自己為什麼你在做一件特別的事情。當然,並非總是如此,並非顯而易見。

甚至到了6個月後,如果您在代碼庫的另一部分工作,然後又回到那一行代碼,您很可能就不會記得編輯該代碼時遇到的所有問題。您可能記得90%的原因添加了某些內容,但是有些其他內容您找不到了。

代碼不只是說明和註釋。很多時候,您可以看到為什麼要通過源代碼控制添加一行代碼(吉特)。您在Git應用程序中查找該行,該行的歷史記錄將告訴您為什麼您或您的同事在10個月前進行了編輯。如果Git提交消息有用且詳細,請不要“修復錯誤”。這也是一個很好的文檔,特別是在開放源代碼項目中,可以有很多人接觸代碼庫。

如果您正在面試中,並且問自己“我應該在運動中添加評論嗎?”答案永遠是是的

他們最有可能判斷您的評論和代碼。還有您在評論中寫的內容。

我一定會的。無論您有多大的代碼嚮導,也許公司都需要在3個月內解僱您,下一位接替您的人將需要了解您的代碼,因為這是公司的資產。他們真的負擔不起僱用不願意或無法同情其他嘗試閱讀源代碼的人的人。