Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
S
software-development-docs
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
pem
software-development-docs
Commits
6ca231a8
Commit
6ca231a8
authored
Apr 28, 2025
by
César Galvis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: updated code style docs (LIB-134)
parent
f1e7237e
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
7 deletions
+9
-7
code-style.md
docs/development-rules/sections/code-style.md
+9
-7
No files found.
docs/development-rules/sections/code-style.md
View file @
6ca231a8
...
...
@@ -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
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment