ToDo整理のためのコメント
TODO
最も多用する
というか実装時は必ずこれを書いていく
type errorとTODOと、testのredを消していきながら実装する
PR出す時は基本全部消えている
NOTE
雑なコメント
コメントの前段階
なくてもいい気がするmrsekut.icon
TODO: comment: API呼び出すやつとかでいい
PENDING
保留
意図を書いて残す
REPRECATED
JS/TSなら/** @deprecated */と書いたほうがいい
呼び出された時にVSCodeが良い感じに斜線を引いてくれる
JS/TSじゃない時に使うことが多いか
QUESTION
他のチームの人に聞くやつのメモ
reviewしてもらう時に聞くことのメモ
mergeするときには消したい
FIXME
PRをまたぐTODO
code:settings.json
"todohighlight.keywords": [
{
"text": "NOTE:",
"color": "#FF8000",
"borderRadius": "2px",
"backgroundColor": "#F5D0A9"
},
{
"text": "TODO:",
"color": "red",
"border": "1px solid red",
"borderRadius": "2px",
"backgroundColor": "rgba(0,0,0,.2)"
},
{
"text": "PENDING:",
"color": "#00FFFF",
"borderRadius": "2px",
"backgroundColor": "rgba(0,0,0,.2)"
},
{
"text": "DEPRECATED:",
"color": "#D358F7",
"borderRadius": "2px",
"backgroundColor": "rgba(0,0,0,.2)"
},
{
"text": "QUESTION:",
"color": "#3ADF00",
"borderRadius": "2px",
"backgroundColor": "#E0F8E0"
}
],
あんまり種類は増やしたくないmrsekut.icon
これがコード内に残っていると毎朝Slackに通知が飛ぶ
1回のsprint (2 weeks)内で実装するつもり!のやつにこのコメントを付ける