doxygen - 为什么 Doxygen 不接收代码注释

问题描述

我创建了一个具有以下设置的 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(){
    
            }
        }

标签： doxygen

找到了。希望这可以对遇到相同问题的其他人有所帮助。它现在工作得很好，可以轻松解析 Javascript 文件。与 ES6 一起工作，开箱即用。

添加以下设置：

    EXTENSION_MAPPING = js=JavaScript

如果您有一个包含源目录或树的较大项目，您应该将一个或多个根目录分配给 INPUT 标记，并将一个或多个文件模式添加到 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 (fixed format Fortran: FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran。在后一种情况下解析器试图猜测代码是固定格式还是自由格式代码，这是Fortran 类型文件的默认值）。

例如，要使 doxygen 将 .inc 文件视为 Fortran 文件（默认为 PHP），将 .f 文件视为 C（默认为 Fortran），请使用：inc=Fortran f=C。

doxygen - 为什么 Doxygen 不接收代码注释

问题描述

解决方案

推荐阅读