Generics in XML documentation issue

Question

Sto cercando di includere uno snippet di codice nella documentazione XML della mia classe, ma il compilatore si lamenta che un elemento xml non è chiuso! Ecco quello che sto cercando di realizzare

/// <summary> 
/// Method documentation here... 
/// </summary> 
/// <remarks> 
/// <para> 
/// This class should be used as follow: 
/// <br/> 
/// ************** PROBLEM IN NEXT LINE ******************** 
/// <c> MyClass class = new MyClass<String>(); </c> 
/// </para> 
/// </remarks> 
public class MyClass<T>{ 
.... 
} 

Ho provato a sostituire il frammento di codice da /// <c> MyClass class = new MyClass{String}(); </c>

Uno ha sperimentato questo prima?

Grazie per il vostro aiuto

Answer 1

Nella documentazione XML, è necessario sostituire le parentesi triangolari con le parentesi graffe:

/// <summary> 
/// Calls <see cref="DoSomething{T}"/>. 
/// </summary> 
public void CallsDoSomething() 
{ 

} 

public void DoSomething<T>() 
{ 

} 

Il motivo si finisce costretti a fare questo, perché isn realmente' t xml ben formato se si consentono le parentesi triangolari al di fuori del markup dell'elemento.

La sostituzione che hai provato è corretta.

Answer 2

I tuoi <remarks> non vengono mai chiusi.

Sostituire le parentesi angolari come già provato è necessario.

Answer 3

Non hai chiuso l'elemento Remarks nella quarta linea, potrebbe lamentarsi, solo al numero di riga errato.

Inoltre, con esempi contenenti generici, preleva List<string> come il testo letterale List seguito da un elemento XML non chiuso string. Il modo più semplice per farlo è fare List <string&gr; che, se analizzato, produce List<string> senza essere un elemento XML.

Il team # compilatore C aggiunto { e } come sostituti per questo, quindi si può solo fare List{string} e saranno trattati in <> s '.

Answer 4

Un paio di cose:

1. Fuga tuo < e > caratteri sostituendoli con < e >.
2. Chiudere il XML <remarks> sezione con un </remarks>
3. Quando non ha deciso di fare riferimento a una generica in un tag (cioè <see ... />, <seealso ... />, ecc), allora si farebbe in modo simile al seguente: <see cref="SomeMethod{T}(T value)" />. Non specificare mai un tipo concreto nel riferimento (ovvero, non fare <see cref="SomeMethod{String}(String value)" />).

Ecco una versione fissa del vostro XML Commenti:

/// <summary> 
/// Method documentation here... 
/// </summary> 
/// <remarks> 
/// <note type="implementsinfo"> 
///  <para>This class should be used as follow:</para> 
///  <para><c>MyClass class = new MyClass&lt;string&lt;();</c></para> 
/// </note> 
/// </remarks> 
public class MyClass<T> 
{ 
    .... 
}