LINUX.ORG.RU
решено Форум — Development  

Документирование проекта

 


0

2

Всем привет, как лучше всего документировать проект, который возможно будет поддерживаться совсем другими разработчиками, возможно нужно какую-то структурную схему рисовать для удобства, например дерево классов и что-то подобное, ну или просто какую-то навигацию, чтобы будущий разработчик имел представление где и что лежит, в каких файлах, в каких функциях, в каких классах итд., может есть какая-то статья по этому поводу?

★★★
← Вызов метода принадлежащего bобъекту в другом потоке
Подключить SDL_draw.h →
Ответ на: комментарий от Zhbert

это-то само собой, но больше хочется обеспечить разработчика картой, чтобы он не запутался в файлах и классах.

Int64 ★★★
() автор топика
Ответ на: комментарий от dvrts

Вики хорошая идея, тем более на github'е ее можно создать. Но вопрос немного другой )

Int64 ★★★
() автор топика
Ответ на: комментарий от Int64

но больше хочется обеспечить разработчика картой, чтобы он не запутался в файлах и классах

Если проект спроектирован не по удацки - т.е. код хорошо локализован, для каждой небольшой задачи есть своя сущность и лежит она в соотвествующей либе и отдельном файле и т.п - то никакой «карты» не нужно, любой вменяемый разработчик сам всё быстро найдёт.

Нужны только вводные слова из которых будет ясна архитектура проекта и видно с чего можно начать смотреть код, какие задачи ставились перед проектом и что ещё не сделано. Грубо говоря, стоит указывать только данные которые из кода получить трудно (долго) или совсем невозможно.

mashina ★★★★★
()

Открою страшную тайну: в документации надо писать не «что тут происходит», а «зачем оно тут происходит» и «почему происходит именно это и именно так».

А что происходит должно быть и само понятно по коду.

Goury ★★★★★
()
Ответ на: комментарий от mashina

Ну если проект хоть сколько-нибудь сложный — блок-схема происходящего всё-таки будет очень полезна.

Goury ★★★★★
()

хорошие примеры:

kernel.org

python.org

erlang.org

anonymous
()

Если проект большой и сложный - то doxygen + wiki для высокоуровневых вещей.

anonymous
()
Ответ на: комментарий от I-Love-Microsoft

Ого Doxygen походу очень крутая штука, спасибо большое, буду разбираться

Int64 ★★★
() автор топика
Последнее исправление: Int64 (всего исправлений: 1)
Ответ на: комментарий от I-Love-Microsoft

Все очень круто, спасибо, doxygen как раз то что мне нужно!

Int64 ★★★
() автор топика
Ответ на: комментарий от Harald

Да-да, война — это мир, свобода — это рабство, код — это документация.

x3al ★★★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.
← Вызов метода принадлежащего bобъекту в другом потоке
Development
Подключить SDL_draw.h →