3

Is there a standar for Python comments?
I was creating a game in Python and wondering if Python has anything standard just like Java with javadocs. I really was hoping to create some kind of documentation for my game in Python but I would like it to be automatic.

Is there any standard or any simple way to achieve what I want?

Rabbid76
  • 202,892
  • 27
  • 131
  • 174
André Clérigo
  • 846
  • 1
  • 10
  • 30
  • While it's not a standard, many projects use https://www.sphinx-doc.org/ for source code documentation. – jrast Mar 08 '21 at 13:01
  • I'm using numpydoc which works nicely with Sphinx: https://numpydoc.readthedocs.io/en/latest/format.html Example here: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html – Dschoni Mar 08 '21 at 13:03
  • 2
    https://realpython.com/documenting-python-code/ – Rocket Nikita Mar 08 '21 at 13:03
  • 1
    Your question is related to: https://stackoverflow.com/questions/5334531/using-javadoc-for-python-documentation. – BelKed Mar 08 '21 at 13:03

0 Answers0