Форум программистов, компьютерный форум, киберфорум
.NET
Войти
Регистрация
Восстановить пароль
 
Рейтинг 5.00/7: Рейтинг темы: голосов - 7, средняя оценка - 5.00
0 / 0 / 0
Регистрация: 10.06.2019
Сообщений: 95
1

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

15.08.2019, 10:10. Показов 1372. Ответов 6

Подскажите пожалуйста, пишу оконное приложение, с использованием СУБД Firebird, которое нужно задокументировать.
Пробовал doxygen, но он не видит private методы (возможно это можно как то исправить, но я пока что не нашел), и как я понимаю он больше подходит для консольных приложений (или я ошибаюсь).
Так что возможно у кого то был опыт документации оконных приложений, и он мне подскажет что использовал для документирования.
__________________
Помощь в написании контрольных, курсовых и дипломных работ здесь
0
Programming
Эксперт
94731 / 64177 / 26122
Регистрация: 12.04.2006
Сообщений: 116,782
15.08.2019, 10:10
Ответы с готовыми решениями:

как создать сборку для старого проекта и использовать ее в другом проекте?
как создать сборку для старого проекта и использовать ее в другом проекте? Хочу использовать...

Какой IP использовать для широковещательной рассылки
Здравствуйте! Нужно отправить широковещательное сообщение. Мой IP: 10.1.2.3 Маска подсети:...

Какой софт использовать для ключевых слов
Есть ли в интернете софт, в который можно загрузить список ключевых слов, а он бы выдал к ним...

Какой софт использовать для создания апплетов?
каким softом лучше всего разрабатывать апплеты и чтобы был не очень большой?

6
управление сложностью
1685 / 1297 / 260
Регистрация: 22.03.2015
Сообщений: 7,548
Записей в блоге: 5
15.08.2019, 10:41 2
Чем не нравится стандартные методы документирования в VS ?
0
763 / 600 / 268
Регистрация: 04.08.2015
Сообщений: 1,648
15.08.2019, 10:42 3
Для студента этого должно хватить) https://docs.microsoft.com/en-... rp/codedoc
0
Эксперт .NET
15555 / 11804 / 3097
Регистрация: 17.09.2011
Сообщений: 19,716
15.08.2019, 11:42 4
Цитата Сообщение от Никлаус Посмотреть сообщение
Пробовал doxygen, но он не видит private методы
Закрытые члены — это деталь реализации, они и не должны быть в документации.
Документация пишется для тех, кто будет использовать ваши классы — им никакого дела до закрытых членов нет.
Если надо задокументировать закрытые члены для тех, кто будет поддерживать ваши классы, то это делается комментариями прямо в коде.
0
1268 / 969 / 113
Регистрация: 12.01.2010
Сообщений: 1,971
19.08.2019, 21:28 5
обычные XML комментарии единственный православный путь, да и то не везде - для библиотек или АПИ хорошо..
а для обычного внутреннего кода известно правило - нужны комментарии? код надо переписать чтоб были не нужны
если для паразитов манагеров у которых зачесалось одно место и надо что-нибудь куда-нибудь документировать для вида или препода - можно какую-нибудь красивую, но совершенно бесполезную схемку сгенерировать студией или решарпером, добавить воды с терминами и отстанут
0
Эксперт .NET
15555 / 11804 / 3097
Регистрация: 17.09.2011
Сообщений: 19,716
19.08.2019, 23:03 6
Цитата Сообщение от m0nax Посмотреть сообщение
нужны комментарии? код надо переписать чтоб были не нужны
Зачем так категорично?
Не всегда имеется возможность сделать код самодокументируемым: существуют такие неприятные вещи, как реализация обратной совместимости, оптимизации, работа с кривыми сторонними API, да банально сам по себе сложный алгоритм для решения сложной задачи.
Комментирование кода — благое дело, когда используется правильно.
0
0 / 0 / 0
Регистрация: 10.06.2019
Сообщений: 95
20.08.2019, 13:41  [ТС] 7
Всем спасибо, решил использовать Sandcastle Help File Builder (SHFB).
Мы делаем документацию для того, что бы наши последователи могли быстро войти в курс дела, поддерживать и допиливать продукт.
p.s. Мы - два студента, которые переписывают с delphi на c# цепочку ПО, которая используется в бухгалтерии.

Добавлено через 2 минуты
Т.к мы студенты которые перешли только на 3й курс, мы мало знаем, и код у нас мягко говоря так себе. Учитывая то что с c# мы были лишь немного знакомы в начале нашей работы (с того момента прошло всего лишь полтора месяца), конечно в каких то местах он будет не понятен и не логичен, так что в том числе и для этого тоже нужна документация.
0
IT_Exp
Эксперт
87844 / 49110 / 22898
Регистрация: 17.06.2006
Сообщений: 92,604
20.08.2019, 13:41

Какой софт лучше всего использовать для разгона видео Asus gforce7900gs
Какой софт лучше всего использовать для разгона видео Asus gforce7900gs и мамки p5ld2-se\c чегом...

какой лучше движок использовать для следующего проекта?
Подскажите люди добрые, с помощью какого движка можно сделать следующий сайт: http://tonometr5.ru/ ...

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

Какой использовать софт?
Доброго времени суток! Подскажите пожалуйста, какой софт использовать. Задача: Загрузка в...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
7
Ответ Создать тему
Опции темы

КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2022, CyberForum.ru