Question

En C #, je peux joindre une documentation pour les propriétés, méthodes, événements, etc. directement dans le code à l'aide des commentaires de la documentation XML .

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

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

Est-il possible d'insérer une référence à un groupe de méthodes ? Si j'ai plusieurs surcharges du même nom de méthode ...

j'ai essayé

<see cref="M:MethodName"/>

.. mais cela n'a pas fonctionné.

EDIT: BUMP

Était-ce utile?

La solution

Apparemment, il n’ya aucun moyen de le faire.

Autres conseils

Il semble que cela ait été corrigé au moins dans Visual Studio 2012:

<see cref="MethodName"/>

Générera un avertissement:

  

Référence ambiguë dans l'attribut cref: 'MethodName'. En supposant '& # 8230;', mais aurait pu également faire correspondre d'autres surcharges, notamment '& # 8230;'.

Mais l'ajout d'un M: devant élimine l'avertissement:

<see cref="M:MethodName"/>

Il est désormais pris en charge à Sandcastle.

Pour référencer un groupe de méthodes, la syntaxe suivante est requise:

/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }

Notez que cette syntaxe comporte toujours certaines limitations, comme décrit ci-après, cette demande de fonctionnalité en langage C # .

  • La syntaxe n'est pas validée lors de la construction. Les erreurs commises lors de la frappe ne sont signalées que si / lorsque Sandcastle Help File Builder traite les commentaires.
  • La syntaxe uniquement fonctionne s'il existe plusieurs méthodes portant le même nom.
  • Il n’existe pas de mise en évidence de syntaxe ni de prise en charge d’éditeur pour cette syntaxe.
Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top