Documentation
Los temas

Introducción

Creando un tema

Utilice los siguientes pasos para crear un tema:

1. Haga clic en Create New Topic en el panel de control de la etiqueta.
2. Nombre el tema.
3. Proporcione ejemplos detallados en la sección "Ejemplos".
4. Si tiene más para compartir, use las secciones "Sintaxis", "Parámetros" y "Comentarios".

¡Has creado un tema con éxito! El tema estará disponible para todos, y todos pueden editarlo.

¡Recuerda que en la Documentación de desbordamiento de pila, los ejemplos son la estrella del espectáculo!

Anatomía de un tema

Un tema se compone de varias secciones:

Título: Cuál es el tema del tema. Busque primero los temas existentes para asegurarse de que no está repitiendo el contenido que ya existe. Los temas que ya se trataron en otro lugar en Stack Overflow se pueden eliminar.

Versiones: Las versiones donde se aplica el material cubierto por el tema. Puede elegir cualquiera de las versiones enumeradas en el tema de introducción, o eliminarlas todas para indicar que el tema se aplica a todas las versiones. Ver versiones para más información.

Introducción (opcional): explica el principio de organización de los ejemplos contenidos para lectores y colaboradores. Reside sobre los ejemplos y está limitado a 500 caracteres.

Ejemplos: Ejemplos de código para el tema. El código debe ser fácil de leer y bien comentado. La prosa también debe usarse para explicar los conceptos necesarios para entender el código, pero trate de no ser demasiado detallado.

Un ejemplo por tema puede ser "fijado", lo que significa que flota sobre los otros ejemplos. Esto puede ser útil para una introducción extendida que es demasiado larga para la sección Introducción.

Sintaxis (opcional): puede ser apropiado incluir una sintaxis para el tema en cuestión. Esta sección siempre es un bloque de código y debe ser una lista de rebajas:

- class.method(required_parameter [, optional])
- function f(int x) = { code defining what the function does }

Parámetros (opcionales) : al describir un tema con sintaxis, también puede ser apropiado incluir detalles de parámetros. Los parámetros están formateados como una tabla de dos columnas:

| Parameter | Details |  
| --------- | ------- | 
|       yin |    dark | 
|      yang |   light |

Observaciones (opcional) : cualquier información adicional sobre el tema que pueda resultar valiosa para el lector final. Los comentarios son de forma libre.

El tema introductorio

Cuando se crea una nueva etiqueta de documentación, StackOverflow genera automáticamente un tema introductorio , que actúa como un marcador de posición para el primer tema real.

El tema introductorio contiene textos de marcadores de posición y punteros para señalar a los colaboradores en las direcciones correctas para ayudar a expandir la nueva etiqueta de documentación.

Tenga en cuenta que los temas introductorios no se pueden eliminar. Ver esta pregunta