Commented-out code (ARCH3208)

Anahtar typescript.quality.commented-out-code · Önem info · Kategori quality

Düzyazı değil kod olan yorumu işaretler: metni sözdizimi hatası olmadan TypeScript olarak (.tsx dosyasında, JSX’teki {/* ... */} dahil TSX olarak) ayrıştırılıyor ve tek bir kelimeden fazlasını içeriyor, ya da satırlarının en az yarısı tam birer ifade. Hiç derlenmediği için çevresindeki koddan kopar. JSDoc, üçlü eğik çizgi yönergeleri, @ts-/eslint/prettier yönergeleri, TODO tarzı işaretler, lisans başlıkları, URL’ler ve aynı satırda koddan sonra gelen notlar dikkate alınmaz.

Yanlış

export function total(order: Order) {
  // const discount = order.customer.discount
  // order.total -= order.total * discount
  return order.lines.reduce((s, l) => s + l.amount, 0)
}

{/* <Banner title="Sale" onClose={close} /> */}

Doğru

export function total(order: Order) {
  // The discount is applied by the caller, after tax.
  return order.lines.reduce((s, l) => s + l.amount, 0)
}