Página en desarrollo
Última edición: 25/12/2020
Nombres de archivos, carpetas y proyectos
En minúsculas, separando las palabras con el carácter «
_
» (guión bajo) si tiene dos o más palabras. Mejorhello_world.rs
quehelloworld.rs
.Estilos para el código
Con la utilidad
rustfmt
se puede verificar la aplicación de estas indicaciones de estilo:- Cuatro espacios para el sangrado, en lugar de un tabulador.
- El cuerpo de una función va entre corchetes; y el corchete de apertura en la misma línea que la declaración con un espacio en medio.
Recomendaciones para los comentarios
En los comentarios en código:
- Preferir comentarios en línea
//
que comentarios en bloque/* … */
. - En comentarios en línea añadir un espacio después del
//
. - En comentarios en bloque añadir un espacio después de
/*
y antes de*/
; y para más de una línea añadir un salto de línea después de/*
y antes de*/
. - Cuando sigue a una línea de código, añadir un espacio antes del
//
. - Suelen ser frases completas, terminar en
.
y empezar por letra mayúscula. - Respetar un ancho de 80 caracteres, o de 100 si está en un bloque sangrado.
En los comentarios de documentación:
- Seguir criterios similares a los comentarios en código.
- Además, deberían ir antes de los atributos (
#[…]
).
- Preferir comentarios en línea
[lwptoc title=»Resumen de recomendaciones»]
Referencias
Última revisión: 25/12/2020