Python_para_todos

Documentación
guido de un punto, o bien con el símbolo ‘#’ para que se introduzca el
número automáticamente.
1. Python
2. C
3. Java
1.
2.
3.
Python
C
Java
Para describir propiedades de los elementos que estamos documentando
se utilizan los campos o fields. En reStructuredText los campos
comienzan con ‘:’, le sigue el nombre del campo y opcionalmente sus
argumentos, y se cierra de nuevo con ‘:’, para terminar con el cuerpo
del campo.
Estos son algunos de los campos que soporta Epydoc:
Funciones y métodos
:param p: Un parámetro Describe el parámetro p.
:type p: str
:return: True si son
iguales
:rtype: str
:keyword p: Un parámetro
:raise e: Si el parámetro
es cero
Variables
Especifica el tipo esperado para el
parámetro p.
Valor de retorno.
Tipo del valor de retorno.
Descripción del parámetro con
valor por defecto y nombre p.
Describe las circunstancias para
las que se lanza la excepción e.
:ivar v: Una variable Descripción de la instancia v.
:cvar v: Una variable
:var v: Una variable
Descripción de la variable estática
de clase v.
Descripción de la variable v del
módulo.
131