En el momento en que estoy documentando mucho de mi código (Python) y me preguntaba si existe un complemento para Eclipse que pueda generar automáticamente una cadena de documentación para mis funciones, al igual que Visual Studio lo hace para C# al escribir ///
sobre un método.Autogenerar documentación ficticia en el código fuente de Python en eclipse
He estado buscando una solución, pero no he tenido suerte. ¿Alguno de ustedes conoce una solución?
Ejemplo:
Desde mi lista de parámetros en un método de la documentación "de prueba" se creará en mi definición de un método como se muestra a continuación:
def myFunction(self, a, b):
"""
:param a:
:type a:
:param b:
:type b:
:return:
:rtype:
"""
return 'Hello, world'
creo que esto está en contra, en general, del espíritu de pitón. Los parámetros deben auto documentarse a través de su posible nombre detallado. Python utiliza la inferencia de tipo, por lo tanto, una prueba de unidad debe fallar si el tipo de argumento no coincide con el tipo de parámetro deseado. Una documentación de una línea debería ser suficiente. –
De muchas maneras estoy de acuerdo con usted, sin embargo, no creo que mi usuario final lo haga. Él no tiene acceso a las pruebas unitarias, y creo que un buen código documentado que elabore un poco más que los nombres de mis parámetros hacen su vida más fácil y puede comenzar a usar mi API un poco más rápido. (y con menos costos) – aweis
Veo su punto, pero dejaría la información del tipo. –