Вопросы с тегом «documentation»

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 6 лет назад . цель состоит в том, чтобы иметь систему документации онлайн, с этими основными требованиями: …

11 documentation 

Принцип СУХОГО (не повторяй себя) гласит, что «каждое знание должно иметь одно, однозначное, авторитетное представление в системе». В большинстве случаев это относится к коду, но часто оно распространяется и на документацию. Говорят, что каждая программная система имеет архитектуру независимо от того, выбрали вы ее или нет. Другими словами, программное обеспечение, …

11 agile  documentation  architecture  dry 

В настоящее время этот вопрос не очень подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, вызовет дебаты, споры, опрос или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и, возможно, вновь открыть, обратитесь за …

11 project-management  business  management  documentation 

Наше программное обеспечение имеет несколько классов, которые должны быть динамически найдены с помощью отражения. Все классы имеют конструктор с определенной сигнатурой, посредством которой код отражения создает объекты. Однако, когда кто-то проверяет, есть ли ссылка на метод (например, через Visual Studio Code Lens), ссылка через отражение не учитывается. Люди могут пропустить …

11 c#  .net  documentation  reflection 

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

11 documentation  comments 

На мой взгляд, сами случаи модульного тестирования служат документацией для кода. Моя компания хочет, чтобы я написал подробные комментарии по документам Java в верхней части тестовых случаев. Это нужно сделать? Вы пишете такие комментарии?

11 unit-testing  documentation 

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

10 documentation  api-design  error-handling  error-messages 

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

10 architecture  documentation 

Я единственный разработчик проекта, который, как и любой программный проект, может быть взят кем-то другим в будущем. Допустим, я использовал шаблон X для реализации функции A. После разработки и доработки функции я понимаю, что могу реализовать ту же функцию, используя шаблон Y, о котором я только что узнал. Но функция …

10 design-patterns  refactoring  documentation 

Какую информацию вы ожидаете увидеть в github README? Должно ли все идти в README? т.е. Введение Установка Версии Гид пользователя Реализация тестирование Связанные ресурсы Или вы просто должны поместить некоторые вещи в README (Введение, Установка, Версии), а другую информацию лучше всего поместить в вики Github?

10 documentation  github 

Раньше я был поклонником требования XML-комментариев для документации. С тех пор я передумал по двум основным причинам: Как и хороший код, методы должны быть понятны. На практике большинство XML-комментариев представляют собой бесполезный шум, который не дает никакой дополнительной ценности. Много раз мы просто используем GhostDoc для генерации общих комментариев, и …

10 .net  programming-practices  development-process  documentation  comments 

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

10 agile  documentation  requirements  user-story 

Где я сейчас работаю, общий подход - по возможности избегайте документации Только документ, если это понадобится другой команде просто для пояснения, я не имею в виду документацию по коду - это мы имеем в виду, я имею в виду всю документацию, окружающую процесс проектирования - если это схемы UML или …

10 documentation 

Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 5 лет назад . Команда, в которой я сейчас работаю, испытывает довольно высокую текучесть кадров, …

10 documentation  training 

Я сторонник надлежащим образом документированного кода, и я хорошо осведомлен о возможных его недостатках . Это выходит за рамки этого вопроса. Мне нравится следовать правилу добавления комментариев XML для каждого публичного участника, учитывая, насколько мне нравится IntelliSense в Visual Studio. Однако существует одна форма избыточности, которая беспокоит даже такого чрезмерного …

10 documentation  comments  intellisense