TODO och kodorganisation

Snabböversikt

Rider samlar TODO-kommentarer från hela lösningen i ett eget verktygsfönster. Det passar mindre påminnelser och teknisk skuld nära koden. En TODO-kommentar ersätter inte ett ärende med ansvarig, prioritet och tydliga krav.

TODO-syntax i C#

// TODO: Lägg till ett test för tomt inventarie.
// BUG: Konverteringen misslyckas när ett sparat värde är för stort.
// FIXME: Ersätt den tillfälliga uppslagningen före release.

Rider har inbyggda TODO-mönster som kan ändras under Settings → Editor → TODO. TODO och BUG känns igen i de fördefinierade mönstren; andra etiketter som FIXME kan behöva konfigureras. Kontrollera inställningarna i stället för att anta att alla markeringar hittas automatiskt.

Öppna och granska TODO-listan

Öppna View → Tool Windows → TODO.
Filtrera eller gruppera efter relevanta filer och mappar.
Gå till koden, lös problemet och ta bort eller uppdatera kommentaren.
Flytta uppgifter som kräver samarbete till ärendehanteraren och länka vid behov till ett ärendenummer.

Vad ska du använda?

Situation	Bättre verktyg	Varför
Hitta tillbaka under felsökning	Bokmärke	Ingen källkodsändring
Förklara en ovanlig regel	Vanlig kommentar	Informationen följer koden
Notera en liten återstående ändring	TODO	Kan sökas fram i IDE:n
Följa upp ett releasehinder	Ärende	Synligt, prioriterat och tilldelat
Förklara parametrar för ett API	XML-dokumentation	Hjälper användare och verktyg

Exempel på en tydlig TODO

// TODO(#142): Stöd migrering från sparformat v1 före molnsynk.
public SaveData Read(string path) { /* implementation */ throw new NotImplementedException(); }

Förklara vad som ska göras och varför, och lägg gärna till en ärendereferens. Låt inte föråldrade TODO-kommentarer ligga kvar.

Öva

Lägg en TODO i ett övningsprojekt, hitta den via TODO-fönstret, åtgärda uppgiften och ta bort kommentaren. Jämför med ett anonymt bokmärke.

Vidare läsning