Принцип СУХОГО (не повторяй себя) гласит, что «каждое знание должно иметь одно, однозначное, авторитетное представление в системе». В большинстве случаев это относится к коду, но часто оно распространяется и на документацию. Говорят, что каждая программная система имеет архитектуру независимо от...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 6 лет назад . цель состоит в том, чтобы иметь систему документации онлайн, с этими...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Мне всегда было интересно, как найти...
После долгих поисков я не смог ответить на основной вопрос, касающийся предполагаемого известного в мире разработки программного обеспечения: ЧТО ИЗВЕСТНО: Применение строгой политики в отношении надлежащей документации по коду (будь то теги Doxygen, Javadoc или просто обилие комментариев)...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Кто-нибудь когда-нибудь пытался создать полную документацию кода, прежде...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 5 лет назад . Недавно я прочитал несколько предложений по...
Я хочу улучшить свои навыки программирования, изучая известные проекты с открытым исходным кодом, но я нахожу, что легко потеряться, просто прыгнув в их исходный код. Поэтому я решил прочитать их документацию об их дизайне или архитектуре (например, диаграммы UML), чтобы сначала получить общее...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Я закончил веб-приложение, которое в основном...
На мой взгляд, сами случаи модульного тестирования служат документацией для кода. Моя компания хочет, чтобы я написал подробные комментарии по документам Java в верхней части тестовых случаев. Это нужно сделать? Вы пишете такие...
Иногда есть 1% кода, который является достаточно интенсивным в вычислительном отношении и требует самого тяжелого вида низкоуровневой оптимизации. Примерами являются обработка видео, обработка изображений и все виды обработки сигналов в целом. Цель состоит в том, чтобы документировать и обучать...
У меня есть проект для университета, который я не начну сразу, но долго размышлял над этим. Я понимаю, что разработка университетских проектов не похожа на индустрию (сейчас я сам стажер), поэтому ситуация, на которую я сейчас укажу, может показаться нелепой разработчикам программного обеспечения....
Когда я пишу небольшие сценарии для себя, я складываю свой код с комментариями (иногда я комментирую больше, чем код). Многие люди, с которыми я общаюсь, говорят, что я должен документировать эти сценарии, даже если они являются личными, поэтому, если я когда-нибудь продам их, я буду готов. Но...
Существуют ли общие практики для комментирования регулярных выражений: встроенные комментарии, ссылающиеся на различные части RegEx, или общие комментарии для всех...
Закрыто. Этот вопрос не по теме . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме разработки программного обеспечения стека Exchange. Закрыто 6 лет назад . Я сторонник комментирования исходного кода и документирования программных...
В настоящее время я работаю над окончанием обучения «Разработка программного обеспечения», в рамках которого мне приходится разрабатывать сложное программное обеспечение индивидуально во внешней компании. Все это должно быть сделано структурированным образом, создавая все соответствующие документы....
Наше программное обеспечение имеет несколько классов, которые должны быть динамически найдены с помощью отражения. Все классы имеют конструктор с определенной сигнатурой, посредством которой код отражения создает объекты. Однако, когда кто-то проверяет, есть ли ссылка на метод (например, через...
Трудно сказать, что здесь спрашивают. Этот вопрос является двусмысленным, расплывчатым, неполным, чрезмерно широким или риторическим, и на него нельзя дать разумный ответ в его нынешней форме. Чтобы получить разъяснения по этому вопросу, чтобы его можно было снова открыть, посетите справочный...
Я один из тех разработчиков, которые думают, что написанный код должен быть понятен и читать как книга. ОДНАКО, при разработке кода библиотеки для использования другими людьми, я стараюсь помещать как можно больше документации в файлы заголовков; что поднимает вопрос: стоит ли документировать...
Я сторонник надлежащим образом документированного кода, и я хорошо осведомлен о возможных его недостатках . Это выходит за рамки этого вопроса. Мне нравится следовать правилу добавления комментариев XML для каждого публичного участника, учитывая, насколько мне нравится IntelliSense в Visual Studio....
Где я сейчас работаю, общий подход - по возможности избегайте документации Только документ, если это понадобится другой команде просто для пояснения, я не имею в виду документацию по коду - это мы имеем в виду, я имею в виду всю документацию, окружающую процесс проектирования - если это схемы UML...