Публикации по теме 'documentation'
Иногда быть хорошим разработчиком означает меньше заниматься магией
Будьте хорошим гражданином. Сделайте ваши процессы наглядными
Иногда быть хорошим разработчиком означает меньше заниматься магией
Реализация по умолчанию - это хорошо, но слишком много всего - плохо
Как часто вам приходилось разрабатывать довольно сложные операции с участием разных движущихся частей? Вы собираете все аккуратно, проверяете на наличие ошибок, все работает ...
Затем вы понимаете, что после вашей следующей встречи, на которой они добавили кучу функций в текущую..
Написание самодокументированного кода javascript
Документация является очень важной частью разработки программного обеспечения. С самого начала разработки программного обеспечения и до сих пор разработчики программного обеспечения придерживаются этой дисциплины. При этом я всегда считаю, что сам код должен максимально подробно описывать то, что он делает. Потому что никто не читает документацию XD
Почему
Документация дает нам массу преимуществ. Это помогает нам легко набирать новых сотрудников и не выделять время другого..
Проверка документации и хэширование с помощью Javascript (Ferrum.js 1.9)
В этом посте обсуждаются самые последние дополнения к javascript-библиотеке Ferrum: документация, основанная на тестах, надежная инфраструктура хэширования инфраструктуры, включая хеш-таблицы.
Прошло некоторое время с момента первоначального выпуска ferrum. Более 400 звезд на Github, сто иждивенцев и всего восемь отчетов об ошибках, несомненно, доказывают, что его функции и продуманный дизайн API обеспечивают долгожданное дополнение к библиотечному ландшафту экосистемы javascript...
Что такое cURL и почему это все в документации API?
Я не знаю, как выглядит ваш уголок Интернета, но мой выглядит примерно так:
«Я просто хочу использовать Python, почему в документации мне предлагается использовать curl».
«Я должен что-то делать в локоне? Я никогда им раньше не пользовался ".
«Где мне использовать завиток?»
«Может ли кто-нибудь сказать мне, как именно использовать curl для проекта узла?»
Я давно не ходил на курсы информатики, но даже тогда я не уверен, что меня явно учили, что такое cURL и как его..
Только отсутствие документации?
Сегодня я хочу задать интересный вопрос, который, как мне кажется, действительно заслуживает изучения. А может уже есть ответ и я его игнорирую.
Во многих случаях это случалось со мной, но я полагаю, что это случается и со многими другими программистами, когда, снова взглянув на фрагмент кода, который мы написали за несколько недель до этого, мы задаемся вопросом: «Я действительно написал этот код?», «Что я хотел сделать здесь?» и так далее.
Мы могли бы возразить, что наша главная..
Переосмысление образов разработчиков для технической документации
Кто читает ваши документы?
Документы могут сделать или сломать продукт.
Согласно Опросу о состоянии баз данных 2022 года , документация является вторым по важности фактором, который разработчики используют при принятии решения о том, какую базу данных использовать. А в неофициальном опросе на конференции SciPy 2017 респонденты в среднем считали, что разработчики должны тратить на документацию примерно на 20% больше времени.
Конечные пользователи знают, что документы важны...
Документирование кода Python с помощью строк документации
Python — это язык программирования с несколькими функциями, включая простой для понимания синтаксис и надежные структуры данных, которые позволяют создавать эффективный код. Хотя код, написанный на Python, часто бывает четким и кратким, все же важно документировать его для других, которым может понадобиться читать или поддерживать ваш код. Документация может принимать различные формы, от комментариев в вашем коде до отдельных инструментов документирования, таких как Sphinx . В этой..
