Плохие образцы кода отвлекают вас от библиотек?

Question

Я оцениваю рамки, которые на бумаге выглядят великолепно. Проблема в том, что пример кода неполон и имеет низкое качество. Поставленные эталонные реализации по большей части не предназначены для использования (поэтому их можно рассматривать как пример кода) и только сумели сбить меня с толку.

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

Позволяете ли вы плохим образцам кода изменить ваше представление о фреймворках / библиотеках? До сих пор мой опыт был похож на «эффект возобновления»: если кто-то не приложит усилия к проверке орфографии своего резюме, он, вероятно, не получит работу ...

Answer 1

Я думаю, что это веская причина, чтобы отвернуться и оценить другие библиотеки. Как потенциальный пользователь библиотеки отсутствие документации и / или некорректных примеров кода создает впечатление, что библиотека еще недостаточно зрелая для использования третьими лицами. Со временем он может набрать недостающие части, но до тех пор я думаю, что разумно искать в другом месте.

Недавно я оценивал множество приложений для блогов, которые люди загрузили на github.com. Я быстро пропустил те из них, которые не имели никакой документации, поскольку они явно не были готовы для использования другими. Те, что остались в конце, имели хороший README с информацией о том, как запустить приложение и запустить его, а также онлайн-пример запуска кода.

Answer 2

Для меня это так. Я склонен избегать библиотек, где примеры кода неполные. Если библиотека с открытым исходным кодом, я пропущу ее, так как я могу непосредственно посмотреть на код и посмотреть, являются ли внутренние библиотеки разумными, и я знаю, что, если когда-нибудь возникнет проблема, я мог бы (если бы пришлось) исправить это.

Если библиотека коммерческая, а их образцы и / или документация плохие, я смотрю в другом месте. Я просто рассматриваю это как управление рисками - плохие образцы заставляют меня бояться качества библиотеки в целом.

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

Answer 3

Плохие примеры кода в сочетании с плохой документацией заставят меня отвернуться от библиотеки, если нет веских причин использовать ее. Однако обычно стоит использовать библиотеку с или хорошими примерами кода или хорошей документацией. (Предполагая, что сама библиотека соответствует моим потребностям.)

Answer 4

Отсутствие документации и примеров значительно снижает вероятность использования этой конкретной библиотеки. Не стоит тратить время на тестирование и попытки выяснить, как работает черный ящик, если есть альтернативные решения проблемы.

Answer 5

Если я не могу найти хорошие примеры (и / или документацию), иллюстрирующие, как использовать библиотеку, я, безусловно, с меньшей вероятностью буду использовать ее - просто на практике это будет мне сложнее понять как. Но мне все равно, как выглядит код, который реализует самой библиотеки. Я не думаю, что выбрал бы одну библиотеку / фреймворк вместо другой только потому, что разработчики одной из них продемонстрировали способность писать более чистый код (что, как я понимаю, означает «эффект возобновления»).

Answer 6

Это, безусловно, важно для меня. Доказательства небрежного / неполного кодирования и плохой связи снижают мою уверенность в том, что фактический код реализации стабилен и надежен.

Answer 7

Да, определенно. Каждая библиотека должна иметь простой пример с использованием программы и интерфейса CLI (для очень простых библиотек с <3 методами и <10 хуками достаточно одного примера). </p>

И почему ваш фреймворк "выглядит великолепно", если его так сложно использовать, что даже оригинальные кодеры ошибаются при его использовании?

Answer 8

Себе да, но должны быть люди, которых это не отключило, иначе есть множество проектов с открытым исходным кодом, которые давно бы умерли.