Java 中的注釋
關(guān)于// TODO
“// TODO Auto-generated method stub”
是我們寫類或繼承接口自動(dòng)生成的提示，可以留也可以不用，不過可以提示閱讀者這段代碼是自動(dòng)生成的
根據(jù)下面途徑找到Method body
- window
- Preferences
- Java
- Code Style
- Code Templates
- Code
- Method Body
- Code
- Code Templates
- Code Style
- Java
- Preferences
選擇edit或者雙擊文本區(qū)進(jìn)行編輯芍锚，刪去默認(rèn)的內(nèi)容即可
關(guān)于@Override 的作用
可以說@Override是偽代碼社露，可以表示重寫父類的方法赞弥，刪去也可以，不過我們可以用來當(dāng)作提示映胁。
提示該方法是父類所擁有的，如果你在一個(gè)父類沒有的方法上寫了@Override甲雅，編譯器一般會(huì)報(bào)錯(cuò)解孙。
如果前面沒有@Override坑填，并且方法名是父類中沒有的，編譯器會(huì)認(rèn)為這個(gè)方法是子類中自己增加的方法弛姜。
可以參考下面的代碼：
//這是一個(gè)接口
public interface Framework{
void frameMain(); //用于設(shè)置主窗口
void frameInitial(); //用于初始化各個(gè)部件
void frameAction(); //用于向各個(gè)部件添加事件
void frameLocate(); //用于定位各個(gè)部件在窗口的位置
void frameAdd(); //用于將各個(gè)部件添加到主窗口
void toExit(); //用于一個(gè)釋放該窗口資源的方法
}
/**
* @Author: PQ
* @Data: 2018年8月24日
*/
public class Test implements Framework{
public Test(){
frameMain();
frameInitial();
frameAction();
frameLocate();
frameAdd();
this.setVisible(true); //顯示窗口
}
@Override
public void frameMain() {
// TODO Auto-generated method stub
}
@Override
public void frameInitial() {
// TODO Auto-generated method stub
}
@Override
public void frameAction() {
// TODO Auto-generated method stub
}
@Override
public void frameLocate() {
// TODO Auto-generated method stub
}
@Override
public void frameAdd() {
// TODO Auto-generated method stub
}
@Override
public void toExit() {
// TODO Auto-generated method stub
}
}
注釋問題
“別給糟糕的代碼加注釋-重新寫吧”
什么也比不上放置良好的注釋來的有用
什么也不會(huì)比亂七八糟的注釋更有本事搞亂一個(gè)模塊穷遂。
什么也不會(huì)比陳舊、提供錯(cuò)誤信息的注釋更有破壞性娱据。
- 注釋不能美化糟糕的代碼
寫注釋的常見動(dòng)機(jī)之一是糟糕的代碼的存在蚪黑。
- 用代碼來闡述
有時(shí)候只需要?jiǎng)?chuàng)建一個(gè)描述與注釋所言同一事物的函數(shù)就行
- 好注釋
- 法律信息
- 提供信息的注釋
- 對(duì)意圖的解釋
- 闡釋
注釋把某些晦澀難明的參數(shù)或返回值的意義翻譯為某種可讀形式是有用的，但是盡量讓參數(shù)或者返回值自身足夠清楚就足夠了
- 警示
//Don't look at me codeＶ惺！＜纱！
- TODO 注釋
有時(shí)可以用TODO注釋來標(biāo)注我們這個(gè)函數(shù)將要用來做什么结啼，通常用來表示程序員認(rèn)為應(yīng)該做掠剑，但由于某些原因目前還沒做的工作
- 放大
可以用來放大某種看來不合理的的代碼
壞注釋
通常壞注釋都是糟糕代碼的支撐或借口，對(duì)錯(cuò)誤決策的修正郊愧，
總結(jié)：大多時(shí)候有意義的命名比注釋更友好朴译。
