禁止未标记的 TODO
要求 TODO 必须使用用户标签 (@user
) 或问题引用 (#issue
) 进行注释。
未引用用户或问题的 TODO 会变得过时,且难以获取更多信息。
无效
// TODO Improve calc engine
export function calcValue(): number {}
// TODO Improve calc engine (@djones)
export function calcValue(): number {}
// TODO Improve calc engine (#332)
export function calcValue(): number {}
有效
// TODO(djones) Improve calc engine
export function calcValue(): number {}
// TODO(@djones) Improve calc engine
export function calcValue(): number {}
// TODO(#332)
export function calcValue(): number {}
// TODO(#332) Improve calc engine
export function calcValue(): number {}