2014-12-15 10 views
8

sto ottenendo il seguente messaggio TsLint nel mio progetto:sfondo o un ragionamento per l'errore: TsLint: commento deve iniziare con la lettera minuscola

TsLint: comment must start with lowercase letter

C'è la messa a terra alla base di questo? Sono d'accordo con la maggior parte di ciò che ho incontrato in TsLint e sono consapevole della possibilità di disattivare questo avviso.

Preferisco capire perché suggeriscono questa particolare regola. Ho letto i documenti allo https://github.com/palantir/tslint#supported-rules che spiegano cosa fa la regola ma non perché.

+0

Non uso Typescript, ma sospetto che ci sia una convenzione di codifica che fa un uso speciale dei commenti che iniziano con le maiuscole. – Barmar

+0

In base alla cronologia del check-in all'indirizzo https://github.com/palantir/tslint/commit/b85c254e98551ddb7199918b1b6d458e87875928 questa regola è stata introdotta da https://github.com/gscshoyru il 2 dicembre 2013. Richiedere questa domanda alla fonte potrebbe essere il modo migliore per ottenere la tua risposta – xmojmr

risposta

12

I asked the author su questo.

This is just a style rule, and can safely be ignored if it's not needed

Personalmente, mi viene in mente alcun motivo per far rispettare questa regola quindi vi consiglio di disabilitarlo o ignorarlo.

+9

Wow, questa è la regola più stupida che ricordo di aver visto. Che senso ha dire "i commenti non devono essere frasi inglesi complete?" Penso che "è solo una regola di stile" non è una risposta abbastanza buona per "perché hai pensato che fosse una buona idea?" –

+0

Come ulteriori dettagli per le persone che desiderano sfruttare l'evidenziazione/elaborazione "TODO" dell'IDE, è possibile * aggiungere * parole che ignorerà nelle regole: https://palantir.github.io/tslint/rules/comment-format / –