Комментарии в блоге "Документация, курсы и все остальное..." на "Обновления документации в мае"

Комментарии на "Обновления документации в мае" от Роберт Басыров

Tue, 13 Jun 2023 09:04:46 +0300

День добрый!
Да, Иван, вы правы, мы просто копипастим: банально не хватает времени за всем уследить. Займёмся исправлением этого в ближайшее время, вроде появились возможности.

Спасибо за неравнодушие.

Комментарии на "Обновления документации в мае" от Иван Поддубный

Sun, 11 Jun 2023 19:48:51 +0300

Роберт, много раз поднимавшийся вопрос от коллег: форматирование кода в документации.

Можете ли вы стандартизировать подход к оформлению? Сейчас такое впечатление что вы вообще этим не паритесь - как разработчик дал, вы просто бездумно скопипастили в документацию и не подумали о форматировании кода.

В итоге у нас в каждом разделе рандомно отформатированный код
1. В одном разделе у вас отступы табами (причем огромные на 8 символов)
2. В другом разделе пробелы, причем не 2, ни 4, а 3. 0_о
3. В одном разделе скобку переносите в методах, в другом нет.

Есть инструмент phpcsfixer. Есть форматирование phpstorm. Есть стандарт PSR2/12. На худой конец использовать битриксовый стандарт. Но будьте последовательны.
Форматирование кода - это лицо документации.

Или скопом пробежаться по всем вставкам кода и запустить форматирование (рекомендуется) или запустите тогда компанию по ручному причесыванию.

Нет ни 1 фреймверка или CMS с таким же неряшливым отношением к коду в документации.

Комментарии на "Обновления документации в мае" от Роберт Басыров

Thu, 01 Jun 2023 16:19:19 +0300

Да, недоглядели. Сегодня выгрузили новые скрипты, но вот недоглядели. Исправим.

Комментарии на "Обновления документации в мае" от Алексей Мажейкин

Thu, 01 Jun 2023 16:10:27 +0300

Ну и что вы натворили?
Примеры некорректно отображаются, описание тоже raw html