Documentando en python
Sería algo así como unNice to include en el codigo:
- 79 caracteres por linea máximo
- Usar editores que reemplacen los tabuladores por espacios
- Separar las definiciones de funciones en el nivel superior y las definiciones de clases por dos lineas en blanco.
- Usa una linea en blanco entre la linea de definicion de clase y la de defeinicion del primer método
- Los comentarios en una unica linea entre el codigo deberían ser de tipo #comentario
- La documentacion de fuinciones y clases debe estar en la primera linea tras el inicio de su declaracion, utilizando las triples doble comillas, sin lineas en blanco ni arriba ni abajo.
- La indentacion de la documentacion debe ser la misma que la incluida en la siguiente linea tras la declaración, si
- La documentacion de un modulo debera insertarse tras las lineas de importacion de modulos externos y debera listar todos los metodos, clases y excepciones que puedan ser utilizadas a prtir de la importaion del modulo.
- Es mejor listar los argumentos de las funciones cada uno en una linea diferente.
- Python es sensible a mayusculas (case sensitive).
- La funciones que invoquen al metodo de la superclase deben incluir "extend" y cuando el metodo de la subclase reemplace al de la superclase deben incluir "override".
- Las lineas en blanco dentro de la documentacion maracrán el inicio de nuevos parrafos.
- Y ya me he cansado de escribir.
"""Documentacion de este modulo. |
|---|
Para ello se puede utilizar el siguiente código abierto:


