Форум программистов
 

Восстановите пароль или Зарегистрируйтесь на форуме, о проблемах и с заказом рекламы пишите сюда - alarforum@yandex.ru, проверяйте папку спам!

Вернуться   Форум программистов > IT форум > Общие вопросы по программированию, компьютерный форум
Регистрация

Восстановить пароль
Повторная активизация e-mail

Купить рекламу на форуме - 42 тыс руб за месяц

Ответ
 
Опции темы Поиск в этой теме
Старый 10.02.2020, 08:11   #1
alexmansb
Новичок
Джуниор
 
Регистрация: 10.02.2020
Сообщений: 3
По умолчанию Создание документации к архиву

Подскажите лучший способ для создания документации к моему архиву.
Исходные данные:
есть проект, в котором беспорядочно лежит куча всяких классов (написанных на Java , IDE - IDEA, OS Windows), каждый класс — отдельный файл, на всякий случай я в шапке каждого класса оставлял такой шаблон:
Код:
/**
 * Описание …
* @version 2.1
*/
в этих классах находятся примеры, функции, просто куски кода, т.*е. Какае-то оригинальные решения, которые мне где-либо попадались или сам что-то запиливал, общем по какой-то причине я решил его сохранить. Изначально это не задумывалось как архив, поэтому, в настоящий момент и похоже больше на мусорную свалку. Пока этих классов было 10-50, проблем особо не вызывало, а когда их кол-во перевалило за 100 я стал задумываться как бы мне это все упорядочить.
Вопрос:
Подскажите лучший способ как можно это все упорядочить.
Т.е. какую лучше использовать для этого софтину (только желательно бесплатную) Если надо что-то доработать под нее — не вопрос.
Что я хочу на выходе:
Что бы было какое-то дерево (или папки с подпапками или еще что-то), т.*е. Все это должно быть распределено по каким то темам (подтемам и т.*д.), конечный список ( конкретный класс, метод и т.*д.) должен иметь название на русском и при его выборе (причем не закрывая основного меню или дерева) должно где-то рядом появляться его полное описание. Так же хотелось, что бы был поиск по этим названием, а еще лучше и по описанию.

PS: Программ и способов для создания документации очень много, юзать каждую времени не хватит, попробовал использовать Javadoc – он отказывается отображать текст на русском, попробовал Doxygen – он выводит название всех классов (а мне надо, что бы были мои названия на русском) и чтобы посмотреть описание конкретного класса надо провалиться в него, что не очень удобно, мне надо, чтобы при это не закрывалось основное дерево (меню), т.*е. Чтобы можно было быстро пробежаться по дереву и найти, то что нужно.
Что посоветуете лучше использовать для этого?

Последний раз редактировалось alexmansb; 10.02.2020 в 08:21.
alexmansb вне форума Ответить с цитированием
Ответ


Купить рекламу на форуме - 42 тыс руб за месяц

Опции темы Поиск в этой теме
Поиск в этой теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Создание пользовательской документации для ПО: возможна ли автоматизация процесса? Blondy Общие вопросы по программированию, компьютерный форум 6 13.02.2018 18:16
7Z API. Добавление к существующему архиву. Stilet Win Api 4 03.08.2016 08:32
создание документации .Net Voipp Общие вопросы .NET 1 23.05.2013 12:52
Поиск нормативно-правовых актов, регламентирующих создание сопроводительной документации к ПО Kottik Свободное общение 2 23.07.2010 22:30