Usar encabezados propuesta
Escribiendo especificación describe el título de este artículo
directorio
Condiciones de Uso
1. mantener la separación
Para mantener la separación antes y después, se sugiere que el título de una línea a estar vacío (a menos que el título en el principio del documento); también hay un espacio entre # y el texto del título, si no causará dificultades de lectura.
recomendado:
No se recomienda:
2. Los espacios extra
No tienen espacios adicionales. Sugirió que el título se escribirá en el principio de una línea, el fin no tiene un espacio.
recomendado:
No se recomienda:
3. Puntuacion
títulos recomendados no acaban aquí puntuacion, tales como puntos, comas, dos puntos, punto y coma, y así sucesivamente.
recomendado:
No se recomienda:
4. lo más breve posible
Se sugirió que el título sea lo más breve posible, para facilitar la consulta, sobre todo cuando el directorio de construcción. Si el título fue redactado originalmente por una larga condena, el título se puede extraer de una larga condena, sino como una larga condena en el epígrafe.
recomendado:
No se recomienda:
La estructura se recomienda
Escrito usando Markdown comparación de documentos recomienda la siguiente estructura.
Se describe a continuación.
- Título del documento: El primer título del documento debe ser un título, escrito en la primera fila, se recomienda el mismo nombre de archivo, título de ser lo más breve posible.
- Autor: opcional, el autor ha declarado para el documento, si el documento es un proyecto de código abierto, sugirió que el nombre del autor escrito en el historial de revisiones.
- Resumen: El núcleo de 1-3 Descripción frase del documento
- Contenido: Para una visión rápida de la estructura del documento, una fácil navegación.
- Cuerpo: el cuerpo del título desde el principio del directorio secundaria, aumentando progresivamente, no se salta un grado, no es lo mismo.
La palabra en clave fácil gracias al
点赞apoyo!
