Hintergrund oder Begründung für Fehler: TsLint: Kommentar mit Kleinbuchstaben beginnen muss

Ich erhalte die folgende TsLint Nachricht in meinem Projekt:Hintergrund oder Begründung für Fehler: TsLint: Kommentar mit Kleinbuchstaben beginnen muss

TsLint: comment must start with lowercase letter

Gibt es eine Erdung dahinter? Ich stimme dem überein, was ich in TsLint gesehen habe, und mir ist bewusst, dass ich diese Warnung abschalten kann.

Ich würde lieber verstehen, warum sie diese besondere Regel vorschlagen. Ich lese die Dokumente bei https://github.com/palantir/tslint#supported-rules, die erklären, was die Regel aber nicht warum tut.

Quelle

2014-12-15 Des Horsley

Ich verwende kein Typoskript, aber ich vermute, dass es eine Kodierungskonvention gibt, die besonders Kommentare verwendet, die mit Großbuchstaben beginnen. – Barmar

Laut Check-in-Geschichte bei https://github.com/palantir/tslint/commit/b85c254e98551ddb7199918b1b6d458e87875928 wurde diese Regel von https://github.com/gscshoyru am 2. Dezember 2013 eingeführt. Diese Frage an der Quelle zu stellen könnte sei der beste Weg, um deine Antwort zu bekommen – xmojmr

I asked the author auf diesem.

Persönlich kann ich keinen Grund denken, diese Regel durchzusetzen, also empfehle ich, sie zu deaktivieren oder zu ignorieren.

Quelle

2014-12-17 19:55:23 Fenton

Wow, das ist die dümmste Stilregel, an die ich mich erinnern kann. Was für einen Sinn macht es zu sagen "Kommentare dürfen keine vollständigen englischen Sätze sein?" Ich denke, "es ist nur eine Stilregel" ist keine gute Antwort auf "Warum hast du das für eine gute Idee gehalten?" –

Als zusätzliches Detail für Personen, die die Hervorhebung/Verarbeitung ihrer IDE "TODO" nutzen möchten, * können Sie * Wörter hinzufügen, die in den Regeln ignoriert werden: https://palantir.github.io/tslint/rules/comment-format / –

Hintergrund oder Begründung für Fehler: TsLint: Kommentar mit Kleinbuchstaben beginnen muss

Antwort

Verwandte Themen