Esto está documentado en el sitio web de doxygen , pero para resumir aquí:
Puede usar doxygen para documentar su código Python. Puede utilizar la sintaxis de cadena de documentación de Python:
"""@package docstring
Documentation for this module.
More details.
"""
def func():
"""Documentation for a function.
More details.
"""
pass
En cuyo caso, los comentarios serán extraídos por doxygen, pero no podrá usar ninguno de los comandos especiales de doxygen .
O puede (similar a los lenguajes de estilo C en doxygen) duplicar el marcador de comentario ( #
) en la primera línea antes del miembro:
def func():
pass
En ese caso, puede utilizar los comandos especiales de doxygen. No hay un modo de salida de Python en particular, pero aparentemente puede mejorar los resultados estableciendo OPTMIZE_OUTPUT_JAVA
en YES
.
Honestamente, estoy un poco sorprendido por la diferencia: parece que una vez que doxygen pueda detectar los comentarios en ## bloques o bloques "" ", la mayor parte del trabajo estaría hecho y usted podría usar los comandos especiales en En cualquier caso. ¿Quizás esperan que la gente que usa "" "se adhiera a más prácticas de documentación Pythonic y eso interferiría con los comandos especiales de doxygen?