Skip to content

Estándares de Código

Nomenclatura de Identificadores

ElementoEstiloEjemplo
Funciones/MétodoscamelCaseloadInstalledVersions(), launchGame()
VariablescamelCaseselectedVersion, libPath
ConstantesUPPER_SNAKE_CASEMAX_RETRIES, DEFAULT_TIMEOUT
ClasesPascalCaseLauncherWindow, VersionManager
Carpetasminúsculassrc/, ui/, core/
Archivossnake_caselauncher_window.cpp, version_manager.h

Estructura del Proyecto

Ejemplo de cómo debe estar organizado el código:

text
src/
├── core/
│   ├── version_manager.h
│   ├── version_manager.cpp
│   ├── pack_installer.h
│   └── pack_installer.cpp

├── ui/
│   ├── windows/
│   │   ├── launcher_window.h
│   │   └── launcher_window.cpp
│   ├── dialogs/
│   │   ├── extract_dialog.h
│   │   └── extract_dialog.cpp

Documentación de Código

  • Siempre documenta las funciones públicas.
  • Usa comentarios claros para lógica compleja.
  • Sigue el estilo existente en los archivos.

Ejemplo:

cpp
/**
 * Carga las versiones instaladas desde el directorio de mcpelauncher
 * 
 * @return QStringList con los nombres de las versiones encontradas
 */
QStringList loadInstalledVersions();

Lanzado bajo la Licencia BSD-3-Clause.