For further clarification, C# has the '///' directive which invokes the super-secret-styled Comments which allow you to have nice comments built into intellisense. Java has the '@' directive that allows you to have nice comments as well.
Does Python have something like this?
They are called docstrings in Python. See the documentation.
A nice feature are the code samples (explained here). They allow to put code in the documentation:
>>> 1 + 1
2
>>>
While this doesn't look like much, there is a tool which can scan the docstrings for such patterns and execute this code as unit tests. This makes sure that Python documenation doesn't go out of date (unlike in other languages).
In python a docstring can be viewed via commands.
class myClass:
"""
This is some documentation for the class.
method1()
method2()
"""
def method1(p1):
....
...
...
def method2():
...
...
v = myClass
you can then view the docstring by using either
v.__doc__
or
help(myClass)
# sign.In Python the resource you are looking for is called doc string. Other people have suggested to read the documentation, and I suggest to check this link: Sphinx Project. This is a library that helps you build and documentation, which can be built from doc string.
