Комментировать во всех шапках? - PullRequest
1 голос
/ 20 апреля 2011

Мой профессор сегодня сказал мне, что я должен прокомментировать свой код (PHP и Javascript) во всех заглавных буквах ... есть ли существенная причина для этого или это вопрос передовой практики?

Если так, то почему лучше писать заглавными буквами над предложением?

1 Ответ

1 голос
/ 12 августа 2017

Во-первых, стилистические вопросы, подобные этому, могут быть немного субъективными, поэтому не обязательно есть четко «правильный» или «неправильный» ответ. С учетом вышесказанного я никогда не видел такого в профессионально написанном коде, и я не видел, чтобы эта практика рекомендовалась в каком-либо стандарте кодирования.

Рассмотрим следующий абзац (взято из здесь ):

дал, что О'Брайен показывает высокий уровень осознанности обманчивости и коварства стороны (например, факт, что он допускает участие в создании и продвижении GOLDSTEIN в мифе), что он сам в своем роде ? ПОЧЕМУ ОН НЕ СЧИТАЛ МЫСЛИМ УГОЛОВНОГО? ИЛИ БЫЛИ ЛИ ЧЛЕНЫ ВНУТРЕННЕЙ ПАРТИИ, НЕ ОЖИДАЕМЫЕ, ЧТОБЫ СОГЛАСОВАТЬСЯ С БОЛЬШИНСТВОМ СТОРОНЫ ТО ЖЕ ВРЕМЯ, ЧТО ЧЛЕНЫ НАШЕЙ ПАРТИИ БЫЛИ ДОЛГО КАК ВСЕ, ЧТОБЫ ВСЕ ДРУГИЕ УБЕДИЛИ, ЧТО ОНИ ДЕЛАЛИ? ИЛИ ОН ПРАКТИКУЕТ НЕКОТОРЫЕ ФОРМЫ ДУБЛЕТИНКА?

Противно читать, не так ли?

Вот абзац в «обычном» тексте:

Учитывая, что О'Брайен демонстрирует высокий уровень осведомленности о обмане и злобе партии (например, тот факт, что он признался, что участвовал в создании и пропаганде мифа Гольдштейна), в какой степени он действительно верит в саму систему ? Почему он не считается преступником мысли? Или от членов Внутренней партии на самом деле не ожидали, что они будут соответствовать убеждениям партии в той же степени, в которой члены Внешней партии были уверены в том, что все остальные убеждены в этом? Или он практикует какую-то форму двойного мышления?

Второй, очевидно, способ легче читать. В этом случае использование заглавных букв только затрудняет их чтение.

Единственная причина, по которой я могу подумать, что кто-то мог бы порекомендовать это сделать его легко отличимым от кода, но это не было действительной причиной для длинного времени (если вы не пытаясь написать свой код в блокноте или другом действительно ужасном инструменте), потому что современные IDE решают эту проблему с подсветкой синтаксиса.

...