9
votes

Dans XML DOC, puis-je insérer une référence à un groupe de méthodes? Comment?

en C #, je peux joindre une documentation pour des propriétés, des méthodes, des événements, etc., Directement dans le code en utilisant Commentaires de la documentation XML .

Je sais comment insérer une référence à une méthode particulière: xxx

est un moyen d'insérer une référence à un groupe de méthode ? Où j'ai eu plusieurs surcharges du même nom de méthode ...

J'ai essayé xxx

.. mais cela n'a pas fonctionné.

EDIT: Bump


0 commentaires

3 Réponses :


2
votes

Apparemment, il n'y a aucun moyen de le faire.


0 commentaires

1
votes

Il semble que cela soit fixé au moins au moins dans Visual Studio 2012:

<see cref="M:MethodName"/>


1 commentaires

Ce Documentation Indique que le préfixe "M" est valide dans le XML généré, mais je ne suis pas sûr que cette syntaxe soit prise en charge pour les groupes de méthodes en particulier. Les outils de documentation telles que Sandcastle Interpréter ces références de groupe de méthodes sans erreur?



0
votes

Ceci est maintenant pris en charge dans Sandcastle.

Pour faire référence à un groupe de méthodes, la syntaxe suivante est requise: xxx

Notez que cette syntaxe a encore des limitations, comme décrit Cette demande de fonctionnalité de langue C # .

  • La syntaxe n'est pas validée pendant la construction. Les erreurs faites lors de la frappe ne sont signalées que si / lorsque Sandcastle aidez que le constructeur traite les commentaires.
  • la syntaxe uniquement fonctionne s'il y a plus d'une méthode avec le même nom.
  • Il n'y a pas de mise en surbrillance de la syntaxe ou de support éditeur pour cette syntaxe.

0 commentaires