#documentation-generation #vala
#документация-генерация #vala
Вопрос:
Я хотел бы знать, есть ли инструмент для извлечения документации из исходных файлов vala, как javadoc или doxygen для Java / C /…
Я начал документировать свой код с помощью classic
/**
* I'm a function !
* @arg An argument
* @return I return nothing
*/
Спасибо,
Дэмиен
Ответ №1:
Valadoc делает это. Инструкции о том, как им пользоваться, кажутся немного скудными.
Кроме того, если вы пишете библиотеку, которая будет использоваться как из Vala, так и из C, быстрый тест показывает, что Vala сохраняет /** комментарии к документации при написании кода C. Затем вы можете использовать инструмент документации C, в частности GTK-Doc, для создания документации.
Комментарии:
1. Спасибо, я буду использовать valadoc (я пытаюсь его скомпилировать).
Ответ №2:
Valadoc является официальным инструментом для создания документации, но в некоторых системах make install не работает должным образом (у меня под Ubuntu 11.10).
Итак, вам нужно исправить права на некоторые файлы.
Взгляните на эту страницу : http://www.mail-archive.com/vala-list@gnome.org/msg07321.html