Публикации по теме 'code-documentation'
Что такое подсказки типов Python и как их использовать? — Андрес Бережной
После изучения баз данных SQL с помощью Python и Flask, здесь и здесь , сегодня я хотел представить концепцию подсказок типов в Python, варианты их использования, а также их плюсы и минусы. Типовые подсказки могут быть отличными инструментами для улучшения читабельности вашего кода, но они не всегда являются лучшим решением.
Этот пост задуман как введение в эту тему для начинающих, и я могу написать больше, если будет больше интереса. В результате я ожидаю, что это будет легкое и..
Вопросы по теме 'code-documentation'
C # для требования XML-документации для внутренних членов
В Visual Studio есть отличная функция, позволяющая выдавать кучу предупреждений компилятора, если некоторые из членов public не имеют документации XML.
Я хотел бы иметь то же самое для internal или, лучше, для любых не private участников, но,...
253 просмотров
schedule
21.05.2024
Отключить автоматическое создание заголовка файла (ReSharper и StyleCop)
Недавно я установил R# 6.1 (версия C#, не полная) с StyleCop 4.7.34.0 (с подключаемым модулем R#). При добавлении нового класса в проект автоматически добавляется информация о заголовке файла. Как отключить это?
Я снял флажок «Вставить текст в...
4082 просмотров
schedule
14.12.2023
phpDocumentor — Как задокументировать код обновления другого автора и дату?
Допустим, исходная документация для класса выглядит так:
/**
* My custom class
*
* This class helps you do stuff. It's really great.
*
* @author David Smith
* @version 1.0
*/
Если я приду и переделаю 50% кода, как мне...
507 просмотров
schedule
06.12.2023
Задокументированы ли где-нибудь артефакты сборки Apache Hadoop?
Я только начал работать с Apache Hadoop, поэтому моя первая цель — запустить приложение «hello world». Первой задачей всегда является настройка среды разработки и возможность компилировать код. В частности, я пытаюсь скомпилировать найденные классы...
93 просмотров
schedule
14.11.2022
Есть ли способ описать/подсказать содержимое параметров функции?
Я пытаюсь научиться лучше документировать свой код. Описывая функцию и просто намекая, что она получает dict , кажется, что будущий читатель оставляет довольно мало информации.
Обычно ли вообще делать следующее? Или может быть есть другой...
199 просмотров
schedule
31.03.2024
Есть ли руководство/соглашение по разметке, используемой в официальной документации lua?
Мне постоянно очень трудно читать официальную документацию, когда она связана с кодированием. Обычно я не понимаю этого, если это не связано с примером. Я ищу разъяснений о том, какие соглашения действуют при чтении документов, если таковые имеются....
38 просмотров
schedule
27.01.2024
Документация SWI-Prolog: значение ?, +, - и : в отношении подписей?
Вопрос о документации SWI-Prolog здесь: я пытаюсь понять, что означают ?, + - и : в отношении подписей. Вот некоторые из руководства по SWI-prolog ( https://www.swi-prolog.org/pldoc/doc_for?object=manual ):
append(?List1, ?List2, ?List1AndList2)...
34 просмотров
schedule
30.03.2024