註解是？

註解是一種好習慣，但絕不是用來說明程式如何運作的，我們應該設法讓程式說明自己的運作過程
壞的註解，例如
//a會加1
a = a + 1;
這毫無意義，而且要是未來我們改成
a = a + 2;
註解不但失效，還是詐欺

理想的情況是讓程式碼易讀易懂，程式本身就能夠說明自己的用途
例如
public void count(List<String> words) {
count = words.parallelStream().filter(word -> word.equals(value)).count();
//因為比對文章中的字串是否與值相同的操作是不會互相干擾的，所以平行化串流
}
註解說明了更重要的事情，而不是看就知道的操作過程

API的註解就需要引導呼叫者正確的使用它
也可以在功能測試中來說明使用者故事的完成度