Привет других разработчиков, я, наконец, получил среду рабочей сборки установлен на моей машине Ubuntu здесь и был просматривали исходный код немного. До сих пор мне нравится то, что я вижу, программа использует стандартную библиотеку шаблонов, чтобы избежать грязного кода структуры данных и структура класса, кажется, делает очень хорошее использование государственного / частных доступ для содействия модульности.

Дело в том, что на самом деле, кажется, не хватает, хотя это хорошая организационная структура между .h и .cpp файлов, а также отсутствие функции документации. Я был бы рад, чтобы начать писать документацию для функций с помощью Doxygen Документация системы. Я использую это на OpenDungeons который является игрой я свинцовый кодировщиком, и он служил мне хорошо.

Для тех, кто не знаком с ним, Doxygen работает, читая ваши исходников, чтобы извлечь информацию, которая автоматически собирает (как параметры функции, организация классов и наследования и т.д.), а также информацию вы добавляете себе (комментарии, описывающие, какие функции делать, какие переменные используются для и т.д.). После того, как он разбирает весь код производит каталог, содержащий кучу HTML файлов, которые очень хорошо сшитые и легко ориентироваться. Она также может быть настроена на автоматическую генерацию аккуратных график, показывающие, что вызова подфункция вызывается из каждой функции (так что вы можете отслеживать зависимости / ошибки).

В целом Doxygen является отличной системой, и я был бы рад получить его настроить и начать писать документацию для функций (по крайней мере те, которые я могу понять, так или иначе) и предоставить патчи, так что они могут быть загружены в SVN. Я не хочу, чтобы сделать это, хотя, если другие разработчики будут против этого, так что я хотел разместить здесь, прежде чем я начал. Дайте мне знать, если вы хотите, чтобы я сделал это.

EDIT: В случае, если люди хотят видеть то, что документация по существующей системе выглядит, вот ссылка к документации людоед 3d системы рендеринга. Лучшее место, чтобы получить чувство для документации, нажмите на кнопку "Классы" ссылка в верхней части, а затем посмотреть на страницах нескольких классов.

-доллар