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

Чому в документації на деяких мовах написано "еквівалентно", а не "є"? Наприклад, кажуть Документи Python itertools.chain(*iterables) ... Еквівалентно : def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Або ця посилання C ++ на find_if: Поведінка цього …

23 c++  python  documentation  compiler 

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

22 documentation  code-reviews  documentation-generation  help-documentation 

Мабуть, суперечливим є те, що можна документувати все, включаючи синтаксис геттерів та сеттерів "JavaBean" для полів: люди кажуть, що його непотрібне довге і повторне розбиття DRY (не повторюйте себе) , що конвенція про іменування повинна все пояснювати , і це захаращує код / ​​документацію. Іноді ці аргументи спрацьовують. Але в …

22 documentation 

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

22 unit-testing  documentation 

В даний час ми пишемо функціональні та технічні характеристики у форматі двох стовпців; резюме речення та технічні деталі. Деталі часто посилаються на додаток із діаграмами, конструкції макетів тощо. Однак я бореться з тим, якою напругою писати це: З минулим часом, як ніби робота виконана, я намагаюся показати яскраві розширення виходу …

21 documentation  specifications  writing 

Передумови: Мої співробітники та я пишемо статтю для академічного журналу. У ході наших досліджень ми написали програму моделювання на Java. Ми хочемо зробити програму моделювання вільно доступною для використання іншими. Ми вирішили розмістити код у сховищі GitHub. Щоб полегшити користування іншим, ми хочемо написати гарну документацію для нашої програми, зокрема: …

20 java  documentation 

Отже, у нас є такий інтерфейс /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Нещодавно ми розігрували історію документації, яка передбачала …

20 c#  documentation  xml  documentation-generation 

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

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

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

19 java  documentation  math 

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

18 java  documentation  refactoring  javadocs 

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

18 documentation  wiki 

Припустимо, що ви єдиний розробник, який залишає роботу. Яку інформацію / матеріал, крім самого коду, слід створити та залишити для заміни? Очевидна відповідь - «що б ти не хотів на новій роботі», але минув час, коли я почав нову роботу, і я забуваю, які найважливіші речі мені тоді були потрібні. …

18 documentation  knowledge-transfer 

Один із розробників моєї команди вважає, що потрібно написати коментар javadoc для параметра КОЖНО у підписі методу. Я не думаю, що це потрібно, і насправді я думаю, що це може бути навіть шкідливим. По-перше, я думаю, що назви параметрів повинні бути описовими та самодокументованими. Якщо не відразу зрозуміло, для чого …

18 java  documentation  source-code  comments  maintainability 

Я розглядав, як формально документувати програмні проекти, і я дізнався про IEEE 830-1998: Рекомендована практика для технічних вимог до програмного забезпечення . Однак, як видно із цього посилання, це було замінено. Я знаю, що 830-1998 і, можливо, навіть 830-1993, ймовірно, просто чудові для використання. Однак, якщо нічого іншого, я хотів …

17 documentation  requirements  standards 

Ми всі бачили незліченну кількість прикладів програмного забезпечення, яке постачається з "мінімальними системними вимогами", таких як: Windows XP / Vista / 7 1 Гб оперативної пам’яті 200 МБ пам’яті Як вони загалом визначаються? Очевидно, що іноді існують конкретні обмеження (якщо програма займає 200 МБ на диску, то це сувора вимога). …

17 documentation  requirements  qa