CAP 02 · LEC 04·Sintaxis
Comentarios, formato y convenciones de estilo
El código se lee más veces de las que se escribe. Seguir convenciones de estilo hace que cualquier persona — incluyendo tu yo del futuro — entienda el código a primera vista.
¿Encontraste un error o algo que mejorar?Editá esta lección en GitHub →
Tipos de comentarios
// Comentario de una sola línea
/*
Comentario
de varias líneas
*/
/**
* JSDoc: documenta funciones para el editor
* @param nombre - El nombre de la persona
* @returns El saludo personalizado
*/
function saludar(nombre: string): string {
return `Hola, ${nombre}!`;
}¿Cuándo comentar?
Comenta el porqué, no el qué. El código ya explica qué hace; el comentario debe explicar por qué es necesario o qué problema resuelve. // incrementa contador sobre i++ es ruido — // usamos i++ porque el índice es 1-based en esta API es valioso.
Convenciones de nombres
// Variables y funciones: camelCase
const nombreUsuario = "Ana";
const calcularPrecio = () => {};
// Clases: PascalCase
class GestorDeProductos {}
// Constantes globales: UPPER_SNAKE_CASE
const MAX_REINTENTOS = 3;
const API_URL = "https://api.ejemplo.com";
// Privados (convención no oficial en JS): _prefijo
class Servicio {
_conexionInterna = null;
}
// TypeScript: tipos e interfaces también PascalCase
type EstadoPedido = "pendiente" | "enviado" | "entregado";
interface Usuario {
nombre: string;
edad: number;
}Formato automático con Prettier
Prettier es un formateador de código que convierte esto:
const obj={nombre:"Ana",edad:25,activo:true}
function saludar( n ){return "Hola "+n}
const arr=[1,2, 3,4,5]en esto:
const obj = { nombre: "Ana", edad: 25, activo: true };
function saludar(n) {
return "Hola " + n;
}
const arr = [1, 2, 3, 4, 5];Configura Prettier con .prettierrc:
{
"semi": true,
"singleQuote": true,
"trailingComma": "es5",
"printWidth": 100,
"tabWidth": 2
}