Commit c3a74d6a by César Galvis

docs: updated some markdown files

parent 67741efc
...@@ -5,22 +5,27 @@ ...@@ -5,22 +5,27 @@
Dependiendo del lenguaje, se deberá utilizar la convención de nombres por defecto del mismo. Algunos ejemplos son: Dependiendo del lenguaje, se deberá utilizar la convención de nombres por defecto del mismo. Algunos ejemplos son:
| Lenguaje | Convención de nombres | | Lenguaje | Convención de nombres |
| ----- | ----- | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Javascript, Typescript, Java | [camelCase](https://en.wikipedia.org/wiki/Camel_case) | | Javascript, Typescript, Java | [camelCase](https://en.wikipedia.org/wiki/Camel_case) |
| Python | snake\_case y camelCase ([ver](https://peps.python.org/pep-0008/#naming-conventions)) | | Python | snake\_case y camelCase ([ver](https://peps.python.org/pep-0008/#naming-conventions)) |
| Ruby | snake\_case y camelCase (ver guía de ruby y guía de RoR) | | Ruby | snake\_case y camelCase (ver guía de ruby y guía de RoR) |
| SQL | [snake\_case](https://en.wikipedia.org/wiki/Snake_case) | | SQL | [snake\_case](https://en.wikipedia.org/wiki/Snake_case) |
| MongoDB | camelCase con [variaciones](https://www.mongodb.com/docs/manual/reference/limits/#naming-restrictions) | | MongoDB | camelCase con [variaciones](https://www.mongodb.com/docs/manual/reference/limits/#naming-restrictions) |
| C# | PascalCase con [variaciones](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/identifier-names) |
## Lenguaje de marcado para comentarios ## Lenguaje de marcado para comentarios
Dependiendo del lenguaje, se deberá documentar el código con el formato por defecto del mismo. Algunos ejemplos son: Dependiendo del lenguaje, se deberá documentar el código con el formato por defecto del mismo. Algunos ejemplos son:
| Lenguaje | Convención de nombres | | Lenguaje | Formato |
| ---------------------- | ------------------------------------------------------------------------------------- | | ---------------------- | ------------------------------------------------------------------------------------------------------ |
| Javascript, Typescript | [JSDoc](https://jsdoc.app) | | Javascript, Typescript | [JSDoc](https://jsdoc.app) |
| Java | [Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html) | | Java | [Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html) |
| Python | [Docstring](https://peps.python.org/pep-0008/#documentation-strings) | | Python | [Docstring](https://peps.python.org/pep-0008/#documentation-strings) |
| Ruby | [RDoc](https://github.com/ruby/rdoc) | | Ruby | [RDoc](https://github.com/ruby/rdoc) |
| C# | [XML Docs](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags) |
**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) **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)
* volver al [inicio](/README.md)
* volver a las [normas de desarrollo](/docs/development-rules/README.md)
\ No newline at end of file
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
El uso de diferentes herramientas y frameworks será determinado para cada proyecto, en conjunto con los miembros del equipo, a continuación se presentan algunas recomendaciones generales. El uso de diferentes herramientas y frameworks será determinado para cada proyecto, en conjunto con los miembros del equipo, a continuación se presentan algunas recomendaciones generales.
### Recomendaciones generales ### Recomendaciones generales
* Tener compatibilidad total con el sistema operativo *GNU/Linux* (para facilitar su contenerización y orquestación). * Tener compatibilidad total con el sistema operativo *GNU/Linux* (para facilitar su contenedorización y orquestación).
## Back end ## Back end
......
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