Блог

Я создал файл конфигурации doxygen со следующими настройками (те, которые, по моему мнению, имеют отношение к моему вопросу)

 
    JAVADOC_AUTOBRIEF=YES
    OPTIMIZE_OUTPUT_FOR_JAVA=YES
    EXTRACT_ALL=YES
    EXTRACT_PRIVATE=YES
    EXTRACT_STATIC=YES
    EXTRACT_LOCAL_METHODS=YES

  

Я документирую проект javascript. Я просто хочу, чтобы он отображал мои комментарии в стиле JAVASDOC в исходных файлах. Но это не работает.

Вот пример файла

 
    /// file
    
    export default class FieldController {
    
        constructor(){
    
        }
    
            /// brief  A function
            /// param  A param
            /// param  Another param
            /// return Some return value
            method1(){
    
            }
        }

  

Нашел это. Надеюсь, это может быть полезно другим в той же проблеме. Теперь он отлично работает и легко анализирует файлы Javascript. Работает с ES6 прямо из коробки.

Добавьте следующую настройку:

     EXTENSION_MAPPING = js=JavaScript
  

Если у вас более крупный проект, состоящий из исходного каталога или дерева, вы должны назначить корневой каталог или каталоги входному тегу и добавить один или несколько шаблонов файлов в тег FILE_PATTERNS (например, *.cpp *.h ). Будут проанализированы только файлы, соответствующие одному из шаблонов

Doxygen выбирает анализатор для использования в зависимости от расширения файлов, которые он анализирует. С помощью этого тега вы можете назначить, какой анализатор использовать для данного расширения. Doxygen имеет встроенное сопоставление, но вы можете переопределить или расширить его с помощью этого тега. Формат ext=language, где ext — это расширение файла, а language — один из анализаторов, поддерживаемых doxygen: IDL, Java, JavaScript, Csharp (C #), C, C , D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, Fortran (фиксированный формат Fortran: FortranFixed, свободно форматированный Fortran: FortranFree, неизвестный форматированный Fortran: Fortran. В более позднем случае анализатор пытается угадать, является ли код фиксированным или свободно форматированным кодом, это значение по умолчанию для файлов типа Fortran).

Например, чтобы заставить doxygen обрабатывать файлы .inc как файлы Fortran (по умолчанию PHP), а файлы .f как C (по умолчанию Fortran), используйте: inc= Fortran f = C.