Share via


lnt-naming-convention

Asegúrese de que la convención de nomenclatura de símbolos se alinea con el estilo de codificación, tal como se especifica en el archivo .editorconfig del proyecto.

Para habilitar esta característica, agregue un archivo .editorconfig en el mismo directorio que el archivo del proyecto. .editorconfig especifica las convenciones de nomenclatura para los símbolos del proyecto. Por ejemplo, las convenciones de nomenclatura para los proyectos de Unreal Engine se especifican en un .editorconfig en GitHub.

Una vez que tenga el archivo .editorconfig en el proyecto, active la comprobación lnt-naming-convention con la configuración Convención de nomenclatura en las opciones de estilo de código de C/C++. Para obtener información sobre cómo cambiar esta configuración, consulte Configuración del linter.

Ejemplo

Supongamos que tiene un archivo .editorconfig que contiene:

cpp_naming_style.boolean_style.capitalization = pascal_case
cpp_naming_style.boolean_style.required_prefix = b

El linter marca el código siguiente porque no tiene el prefijo "b" y porque no es un caso Pascal, como se especifica en el archivo .editorconfig:

void example()
{
    bool myFlag = true; // flagged because it doesn't follow the naming convention specified in the .editorconfig
}

Solución del problema

Cambie la nomenclatura para que coincida con el estilo especificado en .editorconfig:

void example()
{ 
    bool bMyFlag = true; // fixed to follow the code style specified in the .editorconfig
} 

El editor puede realizar el cambio por usted. Coloque el cursor en el símbolo marcado. Elija Mostrar posibles correcciones y, a continuación, Aplicar convención de nomenclatura:

Screenshot of the IDE suggesting applying naming convention.

El editor de código muestra bool myFlag = true. Con el cursor en esa línea de código, **Mostrar posibles correcciones** apareció y se eligió. Ahora **Aplicar convención de nomenclatura** está visible y muestra bool my Flag = true en rojo y el cambio sugerido, bool b My Flag, en verde. Ahora puede elegir **Aplicar convención de nomenclatura** para cambiar el código marcado a bool b My Flag = true.

Comentarios

Introducido en Visual Studio 2022 17.7, la comprobación de linter lnt-naming-convention garantiza que las convenciones de nomenclatura se alineen con las especificadas en el archivo .editorconfig. Puede aplicar esta comprobación a cualquier proyecto que tenga un archivo .editorconfig. También puede personalizar el archivo .editorconfig para adaptarse al estilo de codificación del proyecto.

Consulte también

Crear opciones de configuración del editor personalizadas y portátiles con EditorConfig
Información general sobre el linter de código IntelliSense para C++