Come si pluralizza vedere cref="Notazione"?

Question

Come si pluralizza vedere cref="Notazione"?

#1 da (5 voti)
#2 da (3 voti)
#3 da (2 voti)

3

Qual è il modo più appropriato di scrivere questo commento:

    /// <summary>
    /// Order - Identifies the ordinal location of this category
    ///     relative to other listed categories.
    /// </summary>

se voglio racchiudere "categoria" in <see> tag? Ho preso in considerazione:

    /// <summary>
    /// Order - Identifies the ordinal location of this <see cref="Category"/>
    ///     relative to other listed <see cref="Category"/>'s.
    /// </summary>

Vedi il mio dilemma?

Modifica:

Devo aggiungere che sto usando i commenti XML di Visual Studio. Quindi sono piuttosto limitato rispetto allo schema. Credo che cref debba puntare a un riferimento di tipo valido.

comments documentation

posta Jordan 16.02.2011 - 19:48

fonte

3 risposte

3

Non provare a pluralizzare un tag; è difficile da leggere. Usa qualcosa del genere:

/// <summary>
/// Order - Identifies the ordinal location of this <see cref="Category"/>
///     relative to other listed <see cref="Category"/> tags.
/// </summary>

Tuttavia, se devi semplicemente pluralizzare il tag, fallo in questo modo:

///     relative to other listed <see cref="Category"/>s.

Mai usa un apostrofo per pluralizzare. Gli apostrofi sono solo per contrazioni e possesso. (Beh, questo dipende dal tuo utilizzo, l'ho sempre considerato improprio, ma immagino che sia soggettivo. Vedi qui ).

risposta data 16.02.2011 - 19:57

fonte

2

/// <summary>
///     Order - Identifies the ordinal location of the <see> node
///     relative to other listed <see> nodes.
/// </summary>

risposta data 16.02.2011 - 19:51

fonte

Leggi altre domande sui tag comments documentation

Se le password sono memorizzate in hash, vuol dire che teoricamente esiste un'altra password che potrebbe essere utilizzata per accedere? [duplicare] Quale mentalità di programmazione avere nei confronti di JavaScript? [duplicare]

score 5 · Accepted Answer

Il modo migliore per farlo è in realtà specificare un'altra parte di testo separata dal link.

per il tuo esempio invece di scrivere

<see cref="Category"/>

scrivi

<see cref="Category">Categories</see> .

La mancanza di un / alla fine della dichiarazione significa che il segmento successivo diventerà la vera stringa del link, quindi otterrai un link dalla parola "Categorie" che in realtà si riferirà alla "Categoria" oggetto. Questo può anche essere utile per adattare i link in modo più naturale alla tua documentazione in altri modi, ad esempio suddividere un nome di tipo a due parole in due parole effettive separate da uno spazio o abbreviare un nome di tipo lungo.