Запитання з тегом «documentation»

W3Schools має репутацію неповної, іноді некоректної та її реклами; все-таки, коли ви шукаєте деякі речі або посилаєтесь на документацію, відповідаючи на питання ТА, це все ще є єдиним зручним ресурсом крос-браузера. Є й інші ресурси, такі як Мережа розробників Mozilla, яка робить все більшу роботу з документуванням JavaScript, і легендарний …

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 

Зачинено. Це питання поза темою . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно було тематичним для обміну стеками програмного забезпечення. Закрито 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? Приклад Apple бездокументованого …

11 programming-languages  learning  documentation  api 

Після довгого пошуку я не зміг відповісти на основне запитання, яке стосується відомого в світі розробки програмного забезпечення: ЩО ЗНАЄТЬСЯ: Забезпечення суворої політики щодо адекватної документації з кодом (будь то теги Doxygen, Javadoc або просто безліч коментарів) додає надмірної кількості часу, необхідного для розробки коду. АЛЕ: Ретельна документація (або навіть …

11 java  c#  c++  documentation  coding-standards