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

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 6 років тому . мета полягає в створенні системи онлайн-документації з такими основними вимогами: в основному буде використовуватися …

11 documentation 

Принцип DRY (не повторюй себе) зазначає, що "кожен предмет повинен мати єдине, однозначне, авторитетне представлення в системі". Більшість часу це стосується коду, але він часто поширюється і на документацію. Кажуть, що кожна програмна система має архітектуру, вибирали ви її чи ні. Іншими словами, програмне забезпечення, яке ви будуєте, має структуру, …

11 agile  documentation  architecture  dry 

Наразі це запитання не підходить для нашого формату запитань. Ми очікуємо, що відповіді будуть підкріплені фактами, посиланнями або експертними знаннями, але це питання, ймовірно, вимагатиме дискусій, аргументів, опитувань чи розширеної дискусії. Якщо ви вважаєте, що це питання можна вдосконалити та, можливо, знову відкрити, відвідайте довідковий центр для ознайомлення . Закрито …

11 project-management  business  management  documentation 

У нашому програмному забезпеченні є кілька класів, які слід динамічно знаходити за допомогою рефлексії. Усі класи мають конструктор з певним підписом, за допомогою якого код відображення створює об'єкти. Однак, коли хтось перевіряє, чи посилається на метод (наприклад, через Visual Studio Code Lens), посилання через відображення не враховуються. Люди можуть пропустити …

11 c#  .net  documentation  reflection 

Коли я пишу невеликі сценарії для себе, я складаю свій код високо з коментарями (іноді я коментую більше, ніж кодую). Дуже багато людей, з якими я розмовляю, кажуть, що мені слід документувати ці сценарії, навіть якщо вони є особистими, так що якщо я коли-небудь їх продаю, я був би готовий. …

11 documentation  comments 

На мою думку, одиничні тестові приклади самі служать документацією для коду. Моя компанія хоче, щоб я писав докладні коментарі до java doc у верхній частині тестових примірників. Чи потрібно це робити? Ви пишете такі коментарі?

11 unit-testing  documentation 

Ми створюємо комерційну бібліотеку та приклади коду, якими користуються зовнішні розробники. Ми маємо (закриту, доступну для зареєстрованих користувачів) документацію, яка широко пояснює, як користуватися бібліотекою. Багато розробників є першими користувачами, тому виникає багато рудиментарних помилок. Чи доречно включати посилання на документацію в журнал помилок? Які можливі мінуси? Я можу передбачити …

10 documentation  api-design  error-handling  error-messages 

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

10 architecture  documentation 

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

10 design-patterns  refactoring  documentation 

Яку інформацію ви б очікували побачити в github README? Чи повинно все йти в ПОЧАТКУ? тобто Вступ Установка Версії Керівництво користувача Впровадження Тестування Суміжні ресурси Або вам слід просто помістити певні речі у README (Вступ, Встановлення, Версії), а інша інформація найкраще міститись у вікі Github?

10 documentation  github 

Раніше я любив вимагати коментарів XML для документації. З тих пір я передумав з двох основних причин: Як і хороший код, методи повинні бути зрозумілими. На практиці більшість коментарів XML - це марний шум, який не надає додаткової цінності. Багато разів ми просто використовуємо GhostDoc для генерування загальних коментарів, і …

10 .net  programming-practices  development-process  documentation  comments 

Наразі ми використовуємо гнучкі методи в моєму поточному проекті, і ми маємо купу таких історій: Як помічник, я хочу виплатити клієнту відшкодування, щоб він міг отримати трохи грошей, коли вони просять його Як замовник, я хочу оплатити покупку, щоб я міг отримати свій товар. Як ми це робили до цих …

10 agile  documentation  requirements  user-story 

Де я зараз працюю, загальний підхід - уникайте документації якомога більше Документуйте лише, якщо це потребуватиме інша команда просто для уточнення, я не маю на увазі кодову документацію - це ми робимо, я маю на увазі всю документацію, що стосується процесу проектування - якщо це схеми UML або DB, схеми …

10 documentation 

Закрито . Це питання має бути більш зосередженим . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно зосередило увагу на одній проблемі, лише відредагувавши цю публікацію . Закрито 5 років тому . Команда, в якій я зараз є частиною досвіду досить високого обороту, учасники зазвичай переходять …

10 documentation  training 

Я прихильник правильно задокументованого коду, і добре знаю можливі його недоліки . Це виходить за межі цього питання. Мені подобається дотримуватися правила додавання коментарів XML для кожного публічного члена, враховуючи, наскільки мені подобається IntelliSense у Visual Studio. Однак є одна форма надмірності, яка турбує навіть надмірного коментаря, як я. Як …

10 documentation  comments  intellisense