Какой софт использовать для документации проекта

@Никлаус · Регистрация: 10.06.2019

Студворк — интернет-сервис помощи студентам

Подскажите пожалуйста, пишу оконное приложение, с использованием СУБД Firebird, которое нужно задокументировать.
Пробовал doxygen, но он не видит private методы (возможно это можно как то исправить, но я пока что не нашел), и как я понимаю он больше подходит для консольных приложений (или я ошибаюсь).
Так что возможно у кого то был опыт документации оконных приложений, и он мне подскажет что использовал для документирования.

@Почтальон · 15.08.2019, 10:41

Чем не нравится стандартные методы документирования в VS ?

@Igr_ok · 15.08.2019, 10:42

Для студента этого должно хватить) https://docs.microsoft.com/en-... rp/codedoc

@kolorotur · 15.08.2019, 11:42

Сообщение от Никлаус

Пробовал doxygen, но он не видит private методы

Закрытые члены — это деталь реализации, они и не должны быть в документации.
Документация пишется для тех, кто будет использовать ваши классы — им никакого дела до закрытых членов нет.
Если надо задокументировать закрытые члены для тех, кто будет поддерживать ваши классы, то это делается комментариями прямо в коде.

@m0nax · 19.08.2019, 21:28

обычные XML комментарии единственный православный путь, да и то не везде - для библиотек или АПИ хорошо..
а для обычного внутреннего кода известно правило - нужны комментарии? код надо переписать чтоб были не нужны
если для паразитов манагеров у которых зачесалось одно место и надо что-нибудь куда-нибудь документировать для вида или препода - можно какую-нибудь красивую, но совершенно бесполезную схемку сгенерировать студией или решарпером, добавить воды с терминами и отстанут

@kolorotur · 19.08.2019, 23:03

Сообщение от m0nax

нужны комментарии? код надо переписать чтоб были не нужны

Зачем так категорично?
Не всегда имеется возможность сделать код самодокументируемым: существуют такие неприятные вещи, как реализация обратной совместимости, оптимизации, работа с кривыми сторонними API, да банально сам по себе сложный алгоритм для решения сложной задачи.
Комментирование кода — благое дело, когда используется правильно.

@Никлаус · 20.08.2019, 13:41 **[ТС]**

Всем спасибо, решил использовать Sandcastle Help File Builder (SHFB).
Мы делаем документацию для того, что бы наши последователи могли быстро войти в курс дела, поддерживать и допиливать продукт.
p.s. Мы - два студента, которые переписывают с delphi на c# цепочку ПО, которая используется в бухгалтерии.

Добавлено через 2 минуты
Т.к мы студенты которые перешли только на 3й курс, мы мало знаем, и код у нас мягко говоря так себе. Учитывая то что с c# мы были лишь немного знакомы в начале нашей работы (с того момента прошло всего лишь полтора месяца), конечно в каких то местах он будет не понятен и не логичен, так что в том числе и для этого тоже нужна документация.

Новые блоги и статьи Все статьи Все блоги /
Модульный подход на примере F# DevAlt 06.03.2026 В блоге дяди Боба наткнулся на такое определение: В этой книге («Подход, основанный на вариантах использования») Ивар утверждает, что архитектура программного обеспечения — это структуры,. . .	Управление камерой с помощью скрипта OrbitControls.js на Three.js: Вращение, зум и панорамирование 8Observer8 05.03.2026 Содержание блога Финальная демка в браузере работает на Desktop и мобильных браузерах. Итоговый код: orbit-controls-threejs-js. zip. Сканируйте QR-код на мобильном. Вращайте камеру одним пальцем,. . .	SDL3 для Web (WebAssembly): Синхронизация спрайтов SDL3 и тел Box2D 8Observer8 04.03.2026 Содержание блога Финальная демка в браузере. Итоговый код: finish-sync-physics-sprites-sdl3-c. zip На первой гифке отладочные линии отключены, а на второй включены:. . .	SDL3 для Web (WebAssembly): Идентификация объектов на Box2D v3 - использование userData и событий коллизий 8Observer8 02.03.2026 Содержание блога Финальная демка в браузере. Итоговый код: finish-collision-events-sdl3-c. zip Сканируйте QR-код на мобильном и вы увидите, что появится джойстик для управления главным героем. . . .
Реалии Hrethgir 01.03.2026 Нет, я не закончил до сих пор симулятор. Эта задача сложнее. Не получилось уйти в плавсостав, но оно и к лучшему, возможно. Точнее получалось - но сварщиком в палубную команду, а это значит, в моём. . .	Ритм жизни kumehtar 27.02.2026 Иногда приходится жить в ритме, где дел становится всё больше, а вовлечения в происходящее — всё меньше. Плотный график не даёт вниманию закрепиться ни на одном событии. Утро начинается с быстрых,. . .	SDL3 для Web (WebAssembly): Сборка библиотек: SDL3, Box2D, FreeType, SDL3_ttf, SDL3_mixer и SDL3_image из исходников с помощью CMake и Emscripten 8Observer8 27.02.2026 Недавно вышла версия 3. 4. 2 библиотеки SDL3. На странице официальной релиза доступны исходники, готовые DLL (для x86, x64, arm64), а также библиотеки для разработки под Android, MinGW и Visual Studio. . . .	SDL3 для Web (WebAssembly): Реализация движения на Box2D v3 - трение и коллизии с повёрнутыми стенами 8Observer8 20.02.2026 Содержание блога Box2D позволяет легко создать главного героя, который не проходит сквозь стены и перемещается с заданным трением о препятствия, которые можно располагать под углом, как верхнее. . .

@Никлаус 0 / 0 / 0 Регистрация: 10.06.2019 Сообщений: 95

	Какой софт использовать для документации проекта 15.08.2019, 10:10. Показов 2103. Ответов 6 Метки базы данных (Все метки) Подскажите пожалуйста, пишу оконное приложение, с использованием СУБД Firebird, которое нужно задокументировать. Пробовал doxygen, но он не видит private методы (возможно это можно как то исправить, но я пока что не нашел), и как я понимаю он больше подходит для консольных приложений (или я ошибаюсь). Так что возможно у кого то был опыт документации оконных приложений, и он мне подскажет что использовал для документирования. 0

@Почтальон управление сложностью 1693 / 1306 / 259 Регистрация: 22.03.2015 Сообщений: 7,545 Записей в блоге: 5
	15.08.2019, 10:41
	Чем не нравится стандартные методы документирования в VS ? 0

@Igr_ok 785 / 616 / 273 Регистрация: 04.08.2015 Сообщений: 1,713
	15.08.2019, 10:42
	Для студента этого должно хватить) https://docs.microsoft.com/en-... rp/codedoc 0

@m0nax 1274 / 975 / 113 Регистрация: 12.01.2010 Сообщений: 1,971
	19.08.2019, 21:28
	обычные XML комментарии единственный православный путь, да и то не везде - для библиотек или АПИ хорошо.. а для обычного внутреннего кода известно правило - нужны комментарии? код надо переписать чтоб были не нужны если для паразитов манагеров у которых зачесалось одно место и надо что-нибудь куда-нибудь документировать для вида или препода - можно какую-нибудь красивую, но совершенно бесполезную схемку сгенерировать студией или решарпером, добавить воды с терминами и отстанут 0

@Никлаус 0 / 0 / 0 Регистрация: 10.06.2019 Сообщений: 95
	20.08.2019, 13:41 [ТС]
	Всем спасибо, решил использовать Sandcastle Help File Builder (SHFB). Мы делаем документацию для того, что бы наши последователи могли быстро войти в курс дела, поддерживать и допиливать продукт. p.s. Мы - два студента, которые переписывают с delphi на c# цепочку ПО, которая используется в бухгалтерии. Добавлено через 2 минуты Т.к мы студенты которые перешли только на 3й курс, мы мало знаем, и код у нас мягко говоря так себе. Учитывая то что с c# мы были лишь немного знакомы в начале нашей работы (с того момента прошло всего лишь полтора месяца), конечно в каких то местах он будет не понятен и не логичен, так что в том числе и для этого тоже нужна документация. 0