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

W3Schools имеет репутацию неполного, иногда неправильного и занятого рекламой; Тем не менее, при поиске некоторых вещей или ссылки на документацию при ответе на вопрос SO, он по-прежнему является единственным удобным кросс-браузерным ресурсом. Есть и другие ресурсы, такие как Mozilla Developer Network, которая делает все более и более отличную работу по …

12 web-development  documentation  html  css 

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

12 programming-languages  documentation 

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

12 documentation  reverse-engineering 

Мне интересно, что было бы формальным и наиболее распространенным методом документирования бизнес-правил? Также, как вы документируете спецификации пользовательского интерфейса для артефактов разработки (например, Документирование полей формы и как кнопки ведут себя на форме, информационный текст и т. Д.)

12 documentation  business-rules 

В настоящее время я работаю над окончанием обучения «Разработка программного обеспечения», в рамках которого мне приходится разрабатывать сложное программное обеспечение индивидуально во внешней компании. Все это должно быть сделано структурированным образом, создавая все соответствующие документы. Для этого проекта я выбрал работу со стандартными документами IEEE: Документ о требованиях к программному …

11 design  documentation  software  iso 

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

11 productivity  documentation  code-quality  maintainability  engineering 

Существуют ли общие практики для комментирования регулярных выражений: встроенные комментарии, ссылающиеся на различные части RegEx, или общие комментарии для всех выражений?

11 documentation  coding-style  comments 

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

11 documentation  iterative-development 

Иногда есть 1% кода, который является достаточно интенсивным в вычислительном отношении и требует самого тяжелого вида низкоуровневой оптимизации. Примерами являются обработка видео, обработка изображений и все виды обработки сигналов в целом. Цель состоит в том, чтобы документировать и обучать методам оптимизации, чтобы код не становился неуправляемым и не склонным к …

11 documentation  code-reviews  optimization 

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

11 project-management  documentation  documentation-generation  projects-and-solutions 

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

11 open-source  documentation  asp.net-mvc 

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

11 documentation 

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

11 documentation 

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

11 programming-languages  learning  documentation  api 

После долгих поисков я не смог ответить на основной вопрос, касающийся предполагаемого известного в мире разработки программного обеспечения: ЧТО ИЗВЕСТНО: Применение строгой политики в отношении надлежащей документации по коду (будь то теги Doxygen, Javadoc или просто обилие комментариев) увеличивает затраты времени на разработку кода. НО: Наличие подробной документации (или даже …

11 java  c#  c++  documentation  coding-standards