icedoc

icedoc icedoc — это незаметный инструмент для генерации документации интерфейсов, который позволяет создавать документацию без изменения исходного кода.

Инструкции по использованию: com.icedoc.main.Main — это точка входа, необходимо изменить folder на корневой путь проекта, который нужно сканировать, необходимо изменить folderOut на корневой путь сгенерированной документации интерфейсов.

Вот что можно изменить, а можно и оставить без изменений. Файл /icedoc/src/conf.txt содержит настройки конфигурации проекта. title — заголовок файла в документе. version — версия документа. author — автор документа. Файл /icedoc/src/param.txt содержит часто используемые имена параметров URL. Китайские комментарии, расположенные над методом Controller, будут автоматически распознаны. Параметры типа возврата не генерируются, так как они известны только во время выполнения. Однако, если возвращается объект, параметры первого уровня атрибутов объекта будут сгенерированы, а комментарии после каждой строки будут комментариями для возвращаемого значения.