//
// _oo0oo_
// o8888888o
// 88" . "88
// (| -_- |)
// 0\ = /0
// ___/`---'\___
// .' \\| |// '.
// / \\||| : |||// \
// / _||||| -:- |||||- \
// | | \\\ - /// | |
// | \_| ''\---/'' |_/ |
// \ .-\__ '-' ___/-. /
// ___'. .' /--.--\ `. .'___
// ."" '< `.___\_<|>_/___.' >' "".
// | | : `- \`.;`\ _ /`;.`/ - ` : | |
// \ \ `_. \_ __\ /__ _/ .-` / /
// =====`-.____`.___ \_____/___.-`___.-'=====
// `=---='
//
//
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// 佛祖保佑 永无BUG
//
不知道為何，學寫程式的過程總是很少人會告訴你註解該怎麼寫。
註解除了很常見的告訴別人這段程式的意義以外，寫程式總會遇到一些必須做但現在沒辦法做的事，這時候我們可以選擇留下標註。
以下引用IntelliJ IDEA對TODO comments的描述:
Sometimes, you need to mark parts of your code for future reference: areas of optimization and improvement, possible changes, questions to be discussed, and so on. IntelliJ IDEA lets you add special types of comments that are highlighted in the editor, indexed, and listed in the TODO tool window. This way you and your teammates can keep track of issues that require attention.
白話的意思是，我們可以在程式中留下要改善要更動要討論的東西的標記，TODO Comments就是一個這樣的標記，並且藉由工具迅速的列出TODO清單，快速的定位任何留在程式中的TODO。
常用的TODO Comments有
TODO
FIXME
注意的事項
// TODO
FIXME會用在有bug需要修復的情況下以下介紹在VS Code跟Eclipse如何使用TODO Comments
在上一篇Visual Studio Code前端常見擴展工具有推薦過Todo Tree給大家，
安裝完成後可以複製貼上以下的程式到你的開發者工具中試試。
偽代碼
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<!-- TODO 應該改用main來代替div，但要確認rwd畫面不會跑版 by vic -->
<div></div>
<script>
// TODO 這個function用遞迴在xx情況下會導致效能下降太快，待優化 by vic
const a = () => {}
</script>
</body>
</html>
實際畫面
偽代碼
public class TestTodoComments {
public static void main(String[] args) {
// TODO syso不用呼叫兩次 by Vic
System.out.print("Hello ");
System.out.print("World");
}
}
叫出窗格
開啟的檔案中有TODO Comments會在卷軸旁邊出現藍色方框
參考官網
註解來源: https://gist.github.com/edokeh/7580064
iThome鐵人賽
看影片追技術