Предыстория или причина ошибки: TsLint: комментарий должен начинаться со строчной буквы

Я получаю следующее сообщение TsLint в своем проекте:

TsLint: комментарий должен начинаться со строчной буквы

Есть ли за этим какое-то обоснование? Я согласен с большей частью того, что встречал в ЦЛинте, и знаю о возможности отключить это предупреждение.

Я бы предпочел понять, почему они предлагают именно это правило. Я прочитал документацию по адресу https://github.com/palantir/tslint#supported-rules которые объясняют, что делает правило, но не почему.


typescript tslint comments
person Des Horsley    schedule 15.12.2014    source источник
comment
Я не использую Typescript, но подозреваю, что существует соглашение о написании кода, в котором специально используются комментарии, начинающиеся с заглавных букв.   -  person Barmar    schedule 15.12.2014
comment
Согласно истории регистрации на github.com/palantir/tslint/commit/ это правило было введено github.com/gscshoyru 2 декабря 2013 г. Задать этот вопрос у источника может быть лучший способ получить ответ   -  person xmojmr    schedule 15.12.2014

Ответы (2)


arrow_upward
15
arrow_downward

Я спросил автора об этом.

Это просто правило стиля, и его можно смело игнорировать, если оно не нужно.

Лично я не вижу причин для применения этого правила, поэтому рекомендую отключить его или игнорировать.

person Fenton    schedule 17.12.2014
comment
Вау, это самое глупое правило стиля, которое я когда-либо видел. Какой смысл говорить, что комментарии не должны быть полными английскими предложениями? Я думаю, что это просто правило стиля — недостаточно хороший ответ, почему вы решили, что это хорошая идея? - person Joel Mueller; 08.06.2016
comment
В качестве дополнительной информации для тех, кто хочет использовать выделение/обработку TODO своей IDE, вы можете добавить в правила слова, которые будут игнорироваться: palantir.github.io/tslint/rules/comment-format - person random_user_name; 05.08.2017

arrow_upward
0
arrow_downward

добавьте это правило в свой tslint.json:

"comment-format": [false, "check-uppercase"]
person gena_ukr79    schedule 14.03.2019