Documentation
Temi

introduzione

Creare un argomento

Utilizzare la seguente procedura per creare un argomento:

1. Fai clic su Create New Topic nella dashboard del tag.
2. Assegna un nome all'argomento.
3. Fornire esempi dettagliati nella sezione "Esempi".
4. Se ne hai altre da condividere, usa le sezioni "Sintassi", "Parametri" e "Osservazioni".

Hai creato con successo un argomento! L'argomento sarà disponibile per tutti e chiunque potrà modificarlo.

Ricorda che in Stack Overflow Documentation, gli esempi sono la stella dello spettacolo!

Anatomia di un argomento

Un argomento è composto da diverse sezioni:

Titolo: qual è il tema dell'argomento. Cerca prima gli argomenti esistenti per assicurarti di non ripetere contenuti già esistenti. Gli argomenti già trattati altrove su Stack Overflow potrebbero essere eliminati.

Versioni: le versioni in cui si applica il materiale coperto dall'argomento. Puoi scegliere tra le versioni elencate nell'argomento introduttivo oppure rimuoverle tutte per indicare che l'argomento si applica a tutte le versioni. Vedi Versioni per maggiori informazioni.

Introduzione (facoltativo): spiega il principio di organizzazione degli esempi contenuti sia per i lettori che per i contributori. Risiede sopra gli esempi ed è limitato a 500 caratteri.

Esempi: esempi di codice per l'argomento. Il codice dovrebbe essere facile da leggere e ben commentato. La prosa dovrebbe anche essere usata per spiegare i concetti necessari per capire il codice, ma cerca di non essere eccessivamente prolisso.

Un esempio per argomento può essere "appuntato", il che significa che galleggia sopra gli altri esempi. Questo può essere utile per un'introduzione estesa troppo lunga per la sezione Introduzione.

Sintassi (facoltativo): potrebbe essere opportuno includere una sintassi per l'argomento in questione. Questa sezione è sempre un blocco di codice e deve essere una lista di markdown:

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

Parametri (facoltativo) : quando si descrive un argomento come con la sintassi, potrebbe essere opportuno includere anche i dettagli dei parametri. I parametri sono formattati come tabelle a due colonne:

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

Note (facoltativo) : Qualsiasi informazione aggiuntiva relativa all'argomento che potrebbe rivelarsi utile per il lettore finale. Le osservazioni sono a mano libera.

L'argomento introduttivo

Quando viene creato un nuovo tag di documentazione, StackOverflow genera automaticamente un argomento introduttivo , che funge da segnaposto per il primo argomento reale.

L'argomento introduttivo contiene testi segnaposto e indicazioni per indicare i contributori nelle giuste direzioni per aiutare ad espandere il nuovo tag di documentazione.

Si prega di notare che gli argomenti introduttivi non possono essere cancellati. Vedi questa domanda