mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 23:00:18 +00:00
Kenneth Reitz
37 lines
354 B
ReStructuredText
37 lines
354 B
ReStructuredText
Documenting Your Code
|
|
=====================
|
|
|
|
Documenting your code is extremely important. It is debatebly even
|
|
more important than testing.
|
|
|
|
|
|
The Basics
|
|
::::::::::
|
|
|
|
|
|
Code Comments
|
|
-------------
|
|
|
|
|
|
|
|
Doc Strings
|
|
-----------
|
|
|
|
|
|
|
|
Sphinx
|
|
::::::
|
|
|
|
|
|
|
|
Other Tools
|
|
:::::::::::
|
|
|
|
that old thing
|
|
--------------
|
|
|
|
pocco / docco / shocco
|
|
----------------------
|
|
|
|
Ronn
|
|
---- |