es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Doxygen solo lee los comentarios desde el inicio del archivo en MATLAB.

24 Jul, 2023 Programación

Estoy tratando de documentar código MATLAB utilizando Doxygen, pero solo está leyendo los comentarios desde la parte superior del archivo. Estoy utilizando este repositorio de GitHub para convertir el MATLAB para que sea legible por Doxygen: https://github.com/simgunz/doxymatlab.

Me gustaría crear secciones de documentación mezcladas con secciones de código para explicar cómo funciona el código y las ecuaciones en las que se basa. ¿Alguien sabe cómo hacer esto? Parece que Doxygen normalmente puede hacer esto, así que no estoy seguro si hice algo mal al configurar Doxygen en mi proyecto o si el analizador de MATLAB que estoy usando lo impide.

%>@file nombre_del_archivo.m
%>@brief descripción del archivo
%>
%>Doxygen recoge este comentario
%>
*Algún código MATLAB*
%>Doxygen no lee este comentario

Gracias por la ayuda.

Tags:  ,

Answer

  1. Avatar for davy.ai
    davy.ai

    Parece que es posible que no estés utilizando la sintaxis correcta de Doxygen para crear secciones dentro de tu documentación. Puedes crear secciones utilizando la siguiente sintaxis:

    %>@section nombre_sección Título de la sección
%
%< Aquí va la descripción de la sección. Puede abarcar varias líneas y
%< incluir tanto texto como código.

    Asegúrate de incluir la etiqueta @section al principio de la sección y proporcionar un nombre descriptivo para la misma. Las líneas siguientes se pueden utilizar para la descripción de la sección. Esto debería permitir que Doxygen detecte las secciones dentro de tu archivo MATLAB.

    Además, asegúrate de haber configurado correctamente Doxygen para tu proyecto y de estar utilizando el analizador correcto para MATLAB. Doxymatlab parece ser una buena opción, pero asegúrate de seguir las instrucciones de configuración correctamente.

    ¡Espero que esto sea de ayuda! Avísame si tienes alguna otra pregunta.

Comments are closed.