49
ответов
Что самодокументирует код, и он может заменить хорошо зарегистрированный код? [закрытый]
У меня есть коллега, который настаивает, что для его кода не нужны комментарии, это "сам документирование". Я рассмотрел его код, и в то время как это более ясно, чем код, который я видел, что другие производят, я все еще не соглашаюсь...
вопрос задан: 23 August 2011 06:30
38
ответов
Как убедить людей комментировать свой код [закрыто]
Какие есть веские аргументы, чтобы убедить других прокомментировать свой код? Я заметил, что многие программисты предпочитают воспринимаемую скорость написания кода без комментариев, оставляя некоторую документацию для себя ...
вопрос задан: 23 May 2017 11:44
25
ответов
Каково золотое отношение кода/комментария? [закрытый]
Существует ли отношение кода/комментария, что Вы считаете знаком хорошего (плохого) здоровья кода? Можно ли дать примеры проектов с открытым исходным кодом, которые считаются хорошо кодированными и их соответствующий комментарий...
вопрос задан: 21 September 2008 19:22
24
ответа
Что Вы рассматриваете хорошей документацией API? [закрытый]
Мне всегда нравилась документация относительно API Java, вообще говоря, но я знаю, что некоторые люди считают их недостатком. Таким образом, я задаюсь вопросом, что Вы рассматриваете хорошим примером документации API?...
вопрос задан: 8 April 2010 12:40
21
ответ
MS Word является злым! Существует ли хорошая альтернатива? [закрытый]
Как разработчик мне действительно не нравится писать документацию, но когда я имею, я хотел бы сделать процесс максимально безболезненным. Проблема с Word состоит в том, что он постоянно стоит на пути. Я волнуюсь...
вопрос задан: 30 January 2014 09:53
21
ответ
Действительно ли я должен зарегистрировать свои закрытые методы? [закрытый]
Документация закрытых методов может только быть замечена тем, у кого есть доступ к исходному коду. Действительно ли это стоит усилия, потраченного на него?
вопрос задан: 16 November 2009 17:14
21
ответ
Прием в проект - Что я должен спросить предыдущего программиста? [закрытый]
Я занимаю разработку коммерческого веб-сайта. Этот сайт был разработан более чем два года другим программистом. Это - главным образом индивидуальное задание (поддержите и разверните сайт). У меня будет 2-3 днями...
вопрос задан: 13 January 2009 14:39
20
ответов
Преемник к TEX/латексу в поле зрения? [закрытый]
TEX/Латекс является большим, я использую его во многих отношениях. Некоторые его преимущества: это использует текстовые файлы, этот способ, которым входные файлы могут быть diffed, и много инструментов существуют для работы с текстом, это очень гибко, это
вопрос задан: 3 November 2013 18:14
19
ответов
Как “самодокументирование” код может быть, не будучи раздражающим? [закрытый]
Я не уверен, что лучшие практики здесь, но я часто вижу сокращенные имена переменной особенно, когда объем является небольшим. Таким образом (для использования простых примеров Ruby) вместо определения add_location (имя...
вопрос задан: 7 August 2017 20:43
19
ответов
Компания настаивает на том, чтобы использовать двоичный формат для всей нашей [закрытой] документации
Я работаю в компании, которая, по некоторым причинам, настаивает, чтобы вся наша документация разработки была в формате MS Word. Который, будучи двоичным форматом, означает, что мы не можем: Различные версии документа...
вопрос задан: 8 October 2008 13:07
16
ответов
Вы все еще используете UML? Как? Зачем? [закрытый]
Несколько лет отступают, все в нашем магазине были сумасшедшими с UML. Теперь все, кажется, остыли. Мне любопытно, если существует все еще широкое использование UML в проектах программного обеспечения. Если так, это использование...
вопрос задан: 23 May 2017 12:02
15
ответов
Что такое Хорошая Онлайн-документация? [закрытый]
Что это берет для онлайн-документации, чтобы быть полезным и интересным читать? Disclamer: В то время как этот вопрос возникает (я пишу документацию, и, естественно, хочу, чтобы она была...
вопрос задан: 25 January 2009 18:26
15
ответов
Какие инструменты Ваша команда использует для записи руководств пользователя? [закрытый]
Основные запросы: человекочитаемый / текстовый формат (для легкого управления версиями) онлайн (для сотрудничества) легкое форматирование (скидка с цены хорошо, HTML слишком много), строгое форматирование (таким образом, авторы не изобретают новый...
вопрос задан: 25 November 2008 06:57
14
ответов
Что такое хороший пример для наследования классов? [закрытый]
Я пишу документацию для объектно-ориентированного языка и интересно, какие классы были бы хорошим примером для наследования. Некоторые типичные примеры: класс Человек {} класс Сотрудник расширяется...
вопрос задан: 22 February 2009 16:51
13
ответов
Получение разработчиков использовать [закрытую] Wiki
Я работаю над сложным приложением, где различные команды работают над своими собственными модулями со степенью перекрытия. Некоторое время назад мы разбудили набор экземпляра Mediawiki, частично при моем запросе. У меня есть трудная работа...
вопрос задан: 19 August 2008 07:57
12
ответов
Как лучше всего записать документацию, предназначающуюся и для HTML и для PDF? [закрытый]
Преобразователи латекса к HTML, которые я видел в прошлом, были довольно ужасны. Редактирование необработанного HTML не является никакой забавой и, кажется, не переводит хорошо в печатную страницу. Как другие решают эту проблему? Ссылки на...
вопрос задан: 23 May 2017 12:29
12
ответов
Программное обеспечение/Платформа для Совместного использования Спецификаций
Каково программное обеспечение / Wiki, которую Вы используете для записи и совместно используете свои спецификации о разработчиках, тестерах и управлении? Вы используете систему Wiki, и если так, какое программное обеспечение Wiki Вы используете? Или Вы и
вопрос задан: 22 June 2009 01:46
11
ответов
Where to document functions in C or C++? [closed]
I have a C program with multiple files, so I have, for example, stuff.c which implements a few functions, and stuff.h with the function prototypes. How should I go about documenting the functions in ...
вопрос задан: 4 January 2019 23:11
11
ответов
Использование слова «вы» в руководстве пользователя [закрыто]
Я пишу руководство пользователя и вступил в дискуссию с коллегой. Он говорит, что я не могу использовать слово «ты» где-либо в руководстве. Теперь я помню кое-что об этом в школе, но это было ...
вопрос задан: 27 May 2017 01:49
11
ответов
ЛАТЕКС может использоваться для создания какой-либо документации, которая сопровождает программное обеспечение? [закрытый]
Хотя связано с этим вопросом о ЛАТЕКСЕ, используемом вне математики и академии, я конкретно задаюсь вопросом, использует ли кто-либо или знаком с кем-либо, который использует ЛАТЕКС для генерации любого типа...
вопрос задан: 23 May 2017 12:25
11
ответов
Офлайновая документация для различных языков программирования? [закрытый]
Я недавно нашел это: http://php.net/get/php_manual_en.chm/from/a/mirror. Это - .chm файл, который содержит всю документацию для PHP, который можно обычно находить на их сайте. Удобный для офлайнового использования....
вопрос задан: 25 February 2011 19:26
11
ответов
Как создать “граф зависимостей” для [закрытых] активов IT
Один из моих клиентов пытается создать интерактивную "матрицу" взаимозависимостей для различных приложений, использованных в их компании (это - travel&leisure компания приблизительно с 2 500 сотрудниками)...
вопрос задан: 21 June 2010 08:21
11
ответов
Документация разработчика: управление документооборотом Sharepoint по сравнению с [закрытым] ScrewTurn Wiki
Вводная информация я работаю над установкой метода для разработчиков моей компании для совместного использования документации и информации о наших различных внутренних системах. Это колебалось бы от информации, которая будет...
вопрос задан: 25 February 2009 19:35
11
ответов
“Интерфейсы” в Python: да или нет? [закрытый]
Таким образом, я запускаю проект с помощью Python после расходов существенного количества времени на статической земле. Я видел некоторые проекты, которые делают "интерфейсы", которые являются действительно просто классами ни с кем...
вопрос задан: 16 February 2009 02:15
10
ответов
Информация о версии, что для? [закрытый]
Что такое информация о версии для и кто читает их? Они должны быть автоматизированы, просто выложив исправления ошибок для текущего выпуска, или они гарантируют тщательное человеческое редактирование? Так, кто-либо со ссылкой...
вопрос задан: 15 December 2016 22:44
10
ответов
Где я могу найти, что польза подробно ведет к C# 3? [закрытый]
Кажется, что C# 3 поразил меня без меня даже замечающий, могли Вы парни говорить мне о пользе, подробно ведет к C# 3? от лямбды до linq ко всему остальному, что было начато с третьей версии...
вопрос задан: 21 May 2015 15:00
10
ответов
Есть ли некоторые хорошие и современные альтернативы Javadoc? [закрытый]
Давайте столкнемся с ним: Вы не должны быть разработчиком, чтобы видеть, что Javadoc по умолчанию выглядит ужасным. Существуют некоторые ресурсы в сети, которые предлагают модернизированный Javadoc. Но поведение по умолчанию представляет...
вопрос задан: 28 June 2009 21:20
10
ответов
Как Вы избегаете дублирования в комментариях для документации? [закрытый]
Мы только что начали использовать StyleCop и одну вещь, с которой мне приходится нелегко, требования обеспечения документацией. Я не хочу обсуждать полноценность инструмента, я просто задаюсь вопросом, есть ли у кого-либо кто-либо...
вопрос задан: 22 April 2009 18:43
10
ответов
Улучшение [закрытой] удобочитаемости кода
Когда дело доходит до документации кода обычно признается, что код должен объясниться, и документация встроенного кода (исключая общедоступную документацию API) должна только объяснить проблемы метакода...
вопрос задан: 19 April 2009 14:33
10
ответов
Как Вы документируете свою структуру базы данных? [закрытый]
Много систем баз данных не позволяют комментарии или описания таблиц и полей, поэтому как Вы идете о документировании цели таблицы/поля кроме очевидного из наличия хорошего именования...
вопрос задан: 10 October 2008 03:05