代码注释的说明
0. eclipse 代碼注釋
- alt + shift + j:自動添加文檔注釋(作者,時間等)
- 模板注釋自然是可以編輯和定制的;
1. 注釋的對象
- 注釋變量:
- 變量的意義,存儲的是什么內容;
- 尤其對面向對象的編程語言,成員變量的具體含義;
- 注釋函數:
- 函數名
- 函數功能的說明
- 參數及返回值的說明
2. 注釋的位置
- 注釋置于代碼之上:注釋在代碼之前,先看到注釋后看到代碼;
- 注釋置于代碼之后(之右):先看到代碼,再看到注釋;
3. 雜項
- Tricks(四十八)—— 注釋一段代碼
轉載于:https://www.cnblogs.com/mtcnn/p/9421852.html
總結
- 上一篇: BZOJ 1852 [MexicoOI0
- 下一篇: ZeroC ICE的远程调用框架 代理引