Domanda

In C #, posso allegare documentazione per proprietà, metodi, eventi e così via, direttamente nel codice usando Commenti sulla documentazione XML .

So come inserire un riferimento a un metodo particolare:

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

Esiste un modo per inserire un riferimento a un gruppo di metodi ? Dove ho più sovraccarichi con lo stesso nome di metodo ...

Ho provato

<see cref="M:MethodName"/>

..ma che non ha funzionato.

MODIFICA: BUMP

È stato utile?

Soluzione

Apparentemente non c'è modo di farlo.

Altri suggerimenti

Sembra che ciò sia stato corretto almeno in Visual Studio 2012:

<see cref="MethodName"/>

Genera un avviso:

  

Riferimento ambiguo nell'attributo cref: 'MethodName'. Supponendo "& # 8230;", ma avrebbe potuto corrispondere anche ad altri sovraccarichi tra cui "& # 8230;".

Ma aggiungendo un M: di fronte elimina l'avvertimento:

<see cref="M:MethodName"/>

Questo è ora supportato in Sandcastle.

Per fare riferimento a un gruppo di metodi, è richiesta la sintassi seguente:

/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }

Nota che questa sintassi presenta ancora alcune limitazioni, come descritto questa richiesta di funzionalità del linguaggio C # .

  • La sintassi non è convalidata durante la compilazione. Gli errori commessi durante la digitazione non vengono riportati fino a quando / quando Sandcastle Help File Builder elabora i commenti.
  • La sintassi solo funziona se esistono più metodi con lo stesso nome.
  • Non è disponibile l'evidenziazione della sintassi o il supporto dell'editor per questa sintassi.
Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top