2010-02-03 15 views
8

Come scrivere una classe in modo che le descrizioni delle proprietà e dei metodi siano visibili alle persone che fanno riferimento alla dll in altri progetti?Come documentare una C# dll

[Description("My age in years attribute")] 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 

non funziona, nessuno fa

/// <summary> 
    /// My age in years attribute 
    /// </summary> 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 
+0

Il tuo secondo * funziona * per me. –

+0

Forse mi manca qualcosa, ma i commenti xml funzionano per me. –

+0

Il secondo esempio funziona se il progetto che fa riferimento alla classe si trova all'interno della stessa soluzione. Sto compilando la classe come una DLL e facendo riferimento a questa DLL. La DLL non sembra conservare alcun attributo o informazione di riepilogo. – James

risposta

14

In Visual Studio:

Progetto -> Proprietà -> Build -> Controlla "Documentazione File XML".

Per ulteriori dettagli, vedere XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files.

+0

Ciò significa che devo distribuire l'XML con la DLL e fare riferimento ad entrambi? C'è un modo per avere tutte le informazioni nella DLL? – James

+0

No, i commenti XML non fanno parte di alcun metadata nell'assieme. – jason

+0

Come faccio a renderli parte dei metadati? – James

1

La descrizione fornita in DescriptionAttribute è visibile nella proprietà Griglia di sicuro e non ha nulla a che fare con editor di codice.

Per i commenti XML disponibili, è necessario generate an XML documentation file e spedirlo insieme al proprio assieme.

1

Hai costruito il XML documentation file per il tuo secondo caso?

Proprietà del progetto -> Build - di file> [Uscita] documentazione XML

1

Il secondo dovrebbe funzionare (sintesi), accertarsi di selezionare nelle proprietà del progetto (Build -> Output) documentazione XML File .