Je cherche un bon exemple de documentation d'une API (codée en C#) où les structures sont bien documentées.Où puis-je trouver un bon exemple de documentation?
devrait inclure:
En ce moment, je suis à la recherche par http://code.google.com, mais jusqu'à présent je pas trouvé quelque chose d'explicite.
Eh bien, si (commentaires), vous êtes juste après des exemples de code - l'API publique pour protobuf-net a une quantité raisonnable de commentaires de documentation:
Il est rare d'écrire struct s, et en raison de la nature de protobuf-net n'utilise pas beaucoup d'événements - mais vous voyez l'idée.
Ceux-ci sont (bien sûr) expédiés dans un fichier XML à côté de la DLL pour fournir intellisense. Je pourrais y lancer un château de sable - je n'en ai tout simplement pas ressenti le besoin.
comment spécifiez-vous l'auteur et la version? merci –
Pour le projet? AssemblyInfo.cs; pour le fichier? Je devrais probablement ajouter un en-tête commun - je ne l'ai pas fait. Resharper peut aider avec ça. En fonction de l'historique des modifications, le référentiel de code (SVN dans ce cas) appartient à IMO. –
Vous voulez dire, la documentation de quoi? –
Qu'en est-il du .NET Framework? :) – OregonGhost
Cela fonctionne, mais je veux quelque chose de plus petit sur l'échelle ... –