Commit 6ca231a8 by César Galvis

docs: updated code style docs (LIB-134)

parent f1e7237e
......@@ -16,9 +16,11 @@ Dependiendo del lenguaje, se deberá utilizar la convención de nombres por defe
Dependiendo del lenguaje, se deberá documentar el código con el formato por defecto del mismo. Algunos ejemplos son:
| Lenguaje | Convención de nombres |
| ----- | ----- |
| Javascript, Typescript | [JSDoc](https://jsdoc.app) |
| Java | [Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html) |
| Python | [Docstring](https://peps.python.org/pep-0008/#documentation-strings) |
| Ruby | [RDoc](https://github.com/ruby/rdoc) |
\ No newline at end of file
| Lenguaje | Convención de nombres |
| ---------------------- | ------------------------------------------------------------------------------------- |
| Javascript, Typescript | [JSDoc](https://jsdoc.app) |
| Java | [Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html) |
| Python | [Docstring](https://peps.python.org/pep-0008/#documentation-strings) |
| Ruby | [RDoc](https://github.com/ruby/rdoc) |
**NOTA:** El uso de este tipo de comentarios será obligatorio para clases, interfaces y funciones. Para las funciones, se deberán documentar también los tipos de parámetros y el tipo de retorno si aplica (incluyendo manejo de excepciones)
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment