MSDN segue le convenzioni della documentazione per .NET e, in caso affermativo, è pubblicamente disponibile?

6

Durante la navigazione nella documentazione MSDN per la Libreria di classi .NET Framework (FCL) ho sempre stato stupito da come coerente e completamente documentato. È un compagno costante nello sviluppo di applicazioni .NET. La maggior parte dei dubbi che sorgono quando si utilizzano le API sono coperti. Il contrasto con per es. la vecchia documentazione Win32 è sorprendente.

Alcuni esempi:

  • La documentazione per le proprietà inizia sempre con "Ottiene" o "Ottiene o imposta" per specificare gli accessor.
  • I parametri di tipo iniziano con: "Il tipo di ..." .

Microsoft usa una convenzione sulla documentazione che viene seguita per la FCL? Se è così, questa convenzione è disponibile pubblicamente anche per me?

    
posta Steven Jeuris 14.05.2012 - 14:29
fonte

1 risposta

5

Sì. C'è una specie di sorta. Questa specifica è incorporata in StyleCop .

Ciò che sostanzialmente fa è trasformare gli errori di "stile" (commenti, layout del codice / formattazione ecc.) in errori di compilazione.

Puoi anche includere / escludere qualsiasi regola che ti piace.

    
risposta data 14.05.2012 - 18:38
fonte

Leggi altre domande sui tag