Especificación frontal uno (especificación de nomenclatura)

Especificación frontal uno (especificación de nomenclatura)

1. Nomenclatura inferior CamelCase (lowerCamelCase): la primera palabra comienza con una letra minúscula y la primera letra de la segunda palabra es en mayúscula, por ejemplo: nombre, apellido.

2. CamelCase: La primera letra de cada palabra está en mayúscula, por ejemplo: Nombre, Apellido.

3. Nomenclatura de subrayado (snake_case): La nomenclatura de subrayado también se llama caso de serpiente. Consiste enteramente en letras minúsculas y guiones bajos, y está conectada por un subrayado entre las dos palabras. Por ejemplo: nombre.

4. Nomenclatura subrayada (kebab-case): la nomenclatura subrayada también se llama nomenclatura de cadenas, y cada palabra está conectada por un guión bajo "-". Por ejemplo: nombre.

Uso obligatorio: nomenclatura de guión bajo

Reglas de nomenclatura: 1. Los nombres de los archivos no deben contener espacios

2. Se recomienda que solo se utilicen letras minúsculas en el archivo nombres Utilice letras mayúsculas

3. Cuando el nombre del archivo contenga varias palabras, se recomienda separar las palabras con una línea de conjunción (-)

4. Si hay un plural. fórmula estructural, use el plural

Ejemplos: inicio de sesión, página de error, íconos

Uso obligatorio: todas las letras mayúsculas

Para ser llamativo, los nombres de archivo de algunos archivos de descripción pueden usar letras mayúsculas

Ejemplo: README

Instrucciones complementarias: estándar README

◎ Introducción al proyecto.

◎ Cosas a tener en cuenta.

◎ Dirección de muestra online (prueba, oficial).

◎ Admite entorno de ejecución.

◎ Preparación de dependencia necesaria y cómo construirla.

◎ Guía de instalación del proyecto.

◎ Enlaces a documentos relacionados.

◎ Información de contacto del personal relevante.

Ejemplo de README.md:

Uso obligatorio: nomenclatura CamelCase

Reglas de nomenclatura: el prefijo es el verbo, mira el nombre para saber el significado

1. onXxx escucha las devoluciones de llamadas de eventos

2. handleXxx maneja los eventos

3. getXxx obtiene un determinado valor

4. setXxx establece un determinado value

Escenarios comunes:

a. Procesamiento de eventos:

(1) se usa para monitoreo de eventos activo y handleXxx se usa para monitoreo pasivo. procesamiento

Ejemplo: onXxxSubmit: 'Enviar el formulario'

handleXxxSizeChange: 'Procesar el cambio en el número de páginas de paginación'

handleXxxPageChange: 'Procesar el. cambio en el tamaño de cada página de paginación'

onXxxKeydown: 'Presione la tecla Abajo'

(2). Otros nombres: clic en elemento, cambio de elemento, rango de selección

Ejemplo: selectAllXxx: 'Seleccionar todo'

xxxCellClick: ' Este evento se activará cuando se haga clic en una celda'

xxxSortChange: 'Este evento se activará cuando se cumplan las condiciones de clasificación del cambio de tabla'

b. Agregar, eliminar, modificar y procesar consultas:

Agregar: addXxx para agregar un subelemento

createXxx para crear un gran item

Eliminar: eliminarXxx para eliminar el elemento real

eliminarXxx para eliminarlo falsamente

Cambiar: actualizarXxx

Verificar: getXxx necesita modificarse para obtener los datos originales

fetchXxx datos originales

Ejemplo: getUserList: 'Obtener lista de usuarios', fetchToken: 'Obtener token', deleteUser: 'Eliminar usuario', removeTag: 'Eliminar etiqueta', updateUserInfo: 'Actualizar información de usuario', addUser: 'Agregar usuario', createAccount: 'Crear cuenta'

c, función de interfaz API:

get: getXxxApi

publicación: postXxxApi

parche: patchXxxApi

delect: delectXxxApi

Nombre de dominio: xxxUrl

Variables de atributos generales se ven obligados a utilizar: método de nomenclatura en caso de camello

1. Valor booleano

Reglas de nomenclatura: el prefijo es un verbo crítico

hasXxx determina si contiene un valor determinado. verdadero: contiene este valor; falso: no contiene este valor

isXxx determina si es un valor determinado. true: un valor determinado; false: no un valor determinado

Ejemplo: isShow: 'Si se muestra', isLoading: 'Si se está cargando', hasToken: 'Si el token está incluido',

2. Nomenclatura de matrices

Reglas de nomenclatura: utilizar combinación de lista de sustantivos

Ejemplo: lista de usuarios: 'Lista de usuarios'

3. Variables de atributos privados

Reglas de nomenclatura: el prefijo es un guión bajo (_) seguido del mismo nombre que la variable.

4. Variables de enumeración \textcolor{red}{Uso obligatorio: nomenclatura CamelCase}

Los atributos de enumeración utilizan todas las letras mayúsculas y las palabras están separadas por guiones bajos.

Ejemplo: let TargetState = { LECTURA: 1, LEÍDO: 2, APLICADO: 3, LISTO: 4}

5. Constantes: Uso forzado: usar todas las letras mayúsculas, palabras; Separar con guiones bajos

Uso obligatorio: método de nomenclatura en caso de camello

Reglas de nomenclatura: consulte la guía de estilo del sitio web oficial de vue

Por ejemplo: 1. Nombre según para funcionar

2. Los componentes básicos que aplican estilos y convenciones específicos (es decir, componentes de presentación, no lógicos o sin estado) deben comenzar con un prefijo específico, como Base, App o V.

3. El nombre del componente debe comenzar con una palabra de alto nivel (generalmente una descripción general) y terminar con un modificador descriptivo.

Ejemplo: componentes/

|- BaseButton.vue

|- BaseTable.vue

|- BaseIcon.vue

Uso obligatorio: nomenclatura de guión bajo

Reglas de nomenclatura:

1. La denominación de clase, identificación, etiqueta y atributo debe ser lo más breve y clara posible y debe comenzar con letras. Nombre al principio, todas las letras están en minúsculas y las palabras están conectadas con un guión "-"

2. La clase debe representar el contenido o la función del módulo o componente correspondiente y no puede tener nombre. con información de estilo.

3. El ID del elemento debe ser único en la página.

4. Está prohibido crear clases sin información de estilo.

Ejemplo:

1. Intenta no utilizar abreviaturas o palabras abreviadas. Además de template =gt; tmp, message =gt; msg, image =gt; img, property =gt; prop, estas palabras han sido abreviadas.

2. Se prefieren los nombres legibles a los cortos. Naming

3. La longitud del nombre debe estar dentro de los 20 caracteres para evitar inconvenientes en la lectura.

4. El naming debe tener un significado específico y evitar el uso de referencias generales y palabras sin ellas. significado específico

5. No use Pinyin, y mucho menos chino

6. Las expresiones regulares terminan con Exp

7. Ref: use terminación Ref