Хотите улучшить этот вопрос? Обновите вопрос, таким образом, ему можно ответить с фактами и цитатами путем редактирования этого сообщения .
Закрытый в прошлом году .
У меня есть проблема, что я чувствую, что многие программисты могут коснуться...
Я работал над многими мелкомасштабными проектами. После моего начального бумажного шторма мозга я склонен начинать кодировать. То, что я придумываю, обычно является грубой рабочей моделью реального приложения. Я разрабатываю разъединенным способом, таким образом, я говорю о базовых библиотеках кода, пользовательские интерфейсы являются последней вещью, поскольку библиотека обычно диктует то, что необходимо в UI. Поскольку мои проекты становятся больше, я волнуюсь, что так должен моя "спецификация" или документ дизайна.
Вышеупомянутый абзац, от моих расследований, отражен все через Интернет одним способом или другим. Когда UI обеспокоен, что существует немного больше информации, но это - конкретный UI и не имеет отношение к библиотекам кода. То, что я начинаю понимать, - то, что, возможно, код является кодом, код. Кажется от моего обширного исследования, что существует № 1:1, отображающийся между документом дизайна и кодом.
Когда я должен исследовать тему, я вывожу информацию в OneNote, и оттуда я располагаю по приоритетам функции в версии и затем в связанные блоки так, чтобы выполнения разработки довольно линейным способом, мои задачи имели тенденцию быть похожими так:
Реализуйте средство чтения двоичного файла
Реализуйте устройство записи двоичного файла
Создайте Объект инкапсулировать Данные для выражения вызывающей стороне
Теперь любой достойный программист знает, что между теми тремя, чтобы сделать объекты могли быть потенциальной стеной кода, который мог расшириться до нескольких файлов. Я попытался отобразить полный процесс кода для каждой задачи, но я просто не думаю, что это может быть сделано эффективно. К тому времени, когда каждый искажает псевдо код, это - по существу код так или иначе, таким образом, инвестиции времени отрицаются.
Таким образом, мой вопрос - это:
Действительно ли я прав в предположении, что лучшая документация является самим кодом. Мы - все в соглашении, что обзор высокого уровня необходим. Как высоко это должно быть? Вы разрабатываете к оператору, классу или уровню понятия? Какие работы для Вас?