documentation - Can I document Python code with doxygen (and does it make sense)? -
i doxygen create documentation of c or php code. have upcoming python project , think remember python doesn't have /* .. */ comments , has own self-documentation facility seems pythonic way document.
can use doxygen? particular aware of?
i have done coding in python far on small projects lazy document @ (yeah, know ... let's pretend that's ok now).
this documented on doxygen website, summarize here:
you can use doxygen document python code. can either use python documentation string syntax:
"""@package docstring documentation module. more details. """ def func(): """documentation function. more details. """ pass
in case comments extracted doxygen, won't able use of special doxygen commands.
or can (similar c-style languages under doxygen) double comment marker (#
) on first line before member:
## @package pyexample # documentation module. # # more details. ## documentation function. # # more details. def func(): pass
in case, can use special doxygen commands. there's no particular python output mode, can apparently improve results setting optmize_output_java
yes
.
honestly, i'm little surprised @ difference - seems once doxygen can detect comments in ## blocks or """ blocks, of work done , you'd able use special commands in either case. maybe expect people using """ adhere more pythonic documentation practices , interfere special doxygen commands?
Comments
Post a Comment