Comment référencer la bibliothèque de classes .Net Framework dans la documentation

Question

Je travaille sur une documentation et j'ai besoin de faire référence à la bibliothèque de classes .Net Framework. Est-ce que quelqu'un sait la meilleure façon de le faire? Je pensais quelque chose comme ce qui suit:

Net Framework Class Library, http://msdn.microsoft.com/en-us/library/ms229335.aspx

ne sais pas si je dois inclure une date ou quelque chose. Je ne pouvais pas en trouver un sur la page Web, peut-être la date d'aujourd'hui?

Mise à jour: Par documentation, je ne parle pas de documentation dans mon code source. Je parle des documents d'exigences et des manuels d'utilisation. Ces documents sont lus et approuvés par des personnes qui n'ont pas de diplôme en génie logiciel/informatique. Je dois être très explicite avec mes références (donc pourquoi je ne peux pas simplement dire "Vous pouvez utiliser n'importe quoi dans l'espace de noms System.Math" sans fournir une référence à la documentation de .Net Framework).

Answer 1

liens bibliothèque MSDN changent notoirement constamment. Il y a peu de raisons de croire que cela va s'arrêter, il est probable que le commentaire dans le lien sera mort. Franchement, documenter les classes de framework dans votre code source n'est pas très utile. Tout programmeur .NET sait comment les rechercher.

Answer 2

Sur quel type de documentation travaillez-vous?

Étant donné que vous faites référence à un composant natif de l'infrastructure, comme la bibliothèque de classes .NET, vous n'avez pas besoin d'inclure une date pour la référencer. Si c'est vous qui avez créé le composant, alors vous devriez mettre vos informations pour le documenter.

la bibliothèque juste la référence de classe .NET en tant que composant natif de la plate-forme que vous utilisez, je suppose que ça suffit =)