Куда поместить doxygen блоки комментария для внутренней библиотеки - в H или в файлах CPP? [закрытый]
Во-первых, подзапросы в DQL невозможны. См. Выбор из подзапроса в DQL
Во-вторых, вы помещаете вычисляемый SQL из языка запросов Doctrine (DQL) в подзапрос. Это не работает, поскольку база данных не может найти столбец из-за того, что DQL префиксные символы / числовые значения столбцам.
Это значит, что сущности могут корректно отображаться при использовании DQL.
Вам нужно будет создать подзапрос NOT с использованием языка DQL (прекратите использование этого построителя запросов, не уверены, есть ли он, который строит необработанный SQL).
5 ответов
Поместите документацию, где люди считают и запишут его, поскольку они используют и работают над кодом.
комментарии Класса идут перед классами, комментариями метода перед методами.
, Который является лучшим способом удостовериться, вещи сохраняются. Это также сохраняет Ваши заголовочные файлы, относительно склоняются, и избегает касание проблема людей, которых восстанавливают документы метода обновления, заставляющие заголовки быть грязными и инициирование. Я на самом деле знал, что люди используют это в качестве оправдания за запись документации позже!
Заголовки: Легче прочитать комментарии с тех пор существует меньше другого "шума" при рассмотрении файлов.
Источник: Тогда Вы имеете фактические функции в наличии для чтения при рассмотрении комментариев.
Мы просто используем все глобальные функции, прокомментированные в заголовках и локальных функциях, прокомментированных в источнике. Если Вы хотите Вас, может также включать команду copydoc для вставки документации в несколько мест, не имея необходимость несколько раз писать его (лучше для обслуживания)
, Вы могли однако также скопировать результаты к различной документации файла с простой командой. Например:-
Мой file1.h
/**
* \brief Short about function
*
* More about function
*/
WORD my_fync1(BYTE*);
МОЙ file1.c
/** \copydoc my_func1 */
WORD my_fync1(BYTE* data){/*code*/}
Теперь Вы получаете ту же документацию относительно обеих функций.
Это дает Вам меньше шума в файлах кода одновременно, Вы записали документацию в одном месте, представленном в нескольких местах в окончательном результате.
Наличие комментариев в заголовке означает, что все пользователи класса должны быть перекомпилированы, если комментарий изменяется. Для крупные проекты, кодеры будут менее склонны обновить комментарии в заголовках, если они рискнут проводить следующие 20 минут, восстанавливая все.
И.. так как Вы, как предполагается, читаете документ HTML и не просматриваете код для документации, это не большая проблема, которой блоки комментария являются более трудными определить местоположение в исходных файлах.
Я поместил все в заголовочный файл.
я документирую все, но только обычно извлекаю открытый интерфейс.
Обычно я помещал документацию для интерфейса (\param, \return) в.h файле и документации для реализации (\details) в .c/.cpp/.m файле. Doxygen группирует все в документации функции/метода.