在代碼中找到一個放錯地方并且沒有用的注釋是不是很有趣呢？

怎么樣才能做到寫很少的注釋但仍能讓代碼易于理解呢？

一個主要的方式就是讓代碼自我文檔化。當代碼自我文檔化的時候，就不需要注釋去它的作用或者目的，并且也能使代碼變得非常容易維護。

在這里我將提供一些讓你的代碼自我文檔化的方式。下面就是三種使得代碼自文檔化的基本方法：

命名：利用名字來解釋變量、函數等的目的。

封裝函數：將一些特定功能的代碼封裝成一個函數以明確目的。

引入變量：將表達式插入至專用變量。

這可能看上去很簡單，但在實際操作過程中會讓人覺得有點棘手。首先你得明白哪些地方有問題以及哪些地方適用這些方法。

此外，除了上述三種，還有一些應用比較廣泛的方式：

類和模塊接口：將類和模塊中的函數暴露出來，讓代碼更加清晰。

代碼分組：用組來區分不同的代碼片段。