1. 程式人生 > >程式碼規範樣例討論-註釋1

程式碼規範樣例討論-註釋1

“其實沒啥需要多說的,大家參照阿里 java 開發規範就好了。僅僅記錄工作中遇到的討論”

1 簡單的邏輯註釋是否真的需要?參照

王垠推薦的方法行數保持在40行,大約是電腦螢幕的高度。減少上下滑動的操作,可以更加專注。所以減少無用的註釋。

2 由上面程式碼行數引出的一個問題,方法內的簡單的註釋是否可以放到方法的後面?比如這樣? 我覺得是沒問題的

參照:ali java規範 是強制要求的

3

註釋寫序號:疑問 1 2 3.有的寫到  1.1  2.1 2.1 2.3...等等。如果我們要在中間插入一個新邏輯或者刪除一個邏輯,那麼序號都會亂掉,需要重新寫序號。還是很耗時間的