Мне интересно, что должна содержать документация по алгоритму? Не могу найти правильное руководство для подражания. Я имею в виду, чтобы включить краткое изложение алгоритма описание алгоритма блок-схема псевдокоды образец входного набора данных (несколько) выходные данные модульные тесты...
Мне кажется, что вы не можете написать программную спецификацию на английском языке, которая полностью свободна от двусмысленностей, просто из-за неформальной природы естественного языка - и, следовательно, что действительно однозначная спецификация должна включать код, написанный на формально...
Основной частью Domain Driven Design является последовательное использование повсеместного языка в системе - в разговорах, коде, схеме базы данных, пользовательском интерфейсе, тестах и т. Д. Я участвую в проекте, в котором уже существует устоявшийся язык предметной области, определенный...
Я сторонник надлежащим образом документированного кода, и я хорошо осведомлен о возможных его недостатках . Это выходит за рамки этого вопроса. Мне нравится следовать правилу добавления комментариев XML для каждого публичного участника, учитывая, насколько мне нравится IntelliSense в Visual Studio....
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 5 лет назад . Команда, в которой я сейчас работаю, испытывает...
Где я сейчас работаю, общий подход - по возможности избегайте документации Только документ, если это понадобится другой команде просто для пояснения, я не имею в виду документацию по коду - это мы имеем в виду, я имею в виду всю документацию, окружающую процесс проектирования - если это схемы UML...
Сейчас мы используем гибкие методы в моем текущем проекте, и у нас есть куча таких историй: Как помощник, я хочу заплатить клиенту возмещение, чтобы они могли получить немного денег, когда они просят это Как клиент, я хочу оплатить покупку, чтобы я мог получить свой товар. Как мы сделали это до сих...
Мы создаем коммерческую библиотеку и примеры кода, которые используются внешними разработчиками. У нас есть (закрытая, доступная для зарегистрированных пользователей) документация, в которой подробно объясняется, как использовать библиотеку. Многие из разработчиков являются новичками, поэтому...
Я разработчик-любитель, и все мои программы до сих пор были достаточно просты, чтобы их можно было документировать в коде. При чтении кода было ясно, что я делаю с теми или иными действиями (моим стандартным тестом было просмотреть код через 6 месяцев и понять все при первом чтении - и у меня...
Раньше я был поклонником требования XML-комментариев для документации. С тех пор я передумал по двум основным причинам: Как и хороший код, методы должны быть понятны. На практике большинство XML-комментариев представляют собой бесполезный шум, который не дает никакой дополнительной ценности. Много...
Я задокументировал свой код для doxygen, но я не хочу использовать HTML по умолчанию. Я знаю, что могу настроить его, предоставляя собственные CSS, верхние и нижние колонтитулы и т. Д. (Как это делает GNOME), и как я могу добавить общий PHP-код в файлы и сказать, чтобы он сохранялся как .php, но...
Какую информацию вы ожидаете увидеть в github README? Должно ли все идти в README? т.е. Введение Установка Версии Гид пользователя Реализация тестирование Связанные ресурсы Или вы просто должны поместить некоторые вещи в README (Введение, Установка, Версии), а другую информацию лучше всего...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Почему мы до сих пор встраиваем описания исходного...
Я единственный разработчик проекта, который, как и любой программный проект, может быть взят кем-то другим в будущем. Допустим, я использовал шаблон X для реализации функции A. После разработки и доработки функции я понимаю, что могу реализовать ту же функцию, используя шаблон Y, о котором я только...
Это может быть глупый вопрос, но это было в моей голове некоторое время, и я не могу найти достойного ответа где-либо еще. У меня есть учитель, который говорит, что мы должны явно перечислить каждый параметр с описанием, даже если он только один. Это приводит к большому количеству повторений:...
Таким образом, вы исправляете ошибки, а затем встречаете одну, которая может повлиять на другие модули программного продукта. Ваши данные недостаточны для подтверждения вашего утверждения о последствиях исправления, и вас попросили создать документ анализа воздействия. Есть ли определенный процесс,...
Я беру свое первое приложение корпоративного уровня и хочу, чтобы моя команда смоделировала все приложение ASP.NET MVC C # еще до того, как мы выполним одну строку кода. ОБНОВЛЕНИЕ: Это не было философской дискуссией о том, когда документировать / моделировать приложение. Пожалуйста, предоставьте...
Я хочу написать Javadoc в сухом виде. Но документ оракула о Javadoc говорит, что напишите то же самое снова в комментарии метода перегрузки. Могу ли я избежать
Я собираюсь покинуть проект, и прежде чем я уйду, мой начальник попросил меня документировать код (я не очень хорошо задокументировал). Это не имеет большого значения, проект не очень сложный. Но я нахожу в своей документации места, где я хотел бы сказать: «В строке XYZ обратите внимание, что...
Это относится к обсуждению в ответе и комментариям к этому вопросу: что происходит с отвращением к документации в отрасли? , В ответе утверждалось, что «код не может лгать» и, следовательно, должен быть местом для перехода, а не документацией. В нескольких комментариях указывалось, что «код может...