Pergunta

Em C #, posso anexar documentação para propriedades, métodos, eventos e assim por diante, diretamente no código usando href="http://msdn.microsoft.com/en-us/library/b2s063f7.aspx" Comentários .

Eu sei como inserir uma referência a um determinado método:

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

Existe uma maneira de inserir uma referência a um grupo de método ? Onde eu tenho várias sobrecargas do mesmo nome método ...

Eu tentei

<see cref="M:MethodName"/>

.. mas isso não funcionou.

EDIT: COLISÃO

Foi útil?

Solução

Aparentemente não há nenhuma maneira de fazer isso.

Outras dicas

Parece que este foi fixado pelo menos em Visual Studio 2012:

<see cref="MethodName"/>

Irá gerar um aviso:

referência ambígua no atributo CREF: 'MethodName'. Assumindo '...', mas também poderia ter acompanhado outras sobrecargas incluindo '...'.

Mas a adição de um M: em entrar de frente livrar do aviso:

<see cref="M:MethodName"/>

Este é agora suportada no Sandcastle.

Para fazer referência a um grupo método, é necessária a seguinte sintaxe:

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

Note que esta sintaxe ainda tem algumas limitações, como descrito esta C pedido de recurso # idioma .

  • A sintaxe não é validado durante a construção. Erros de digitação não são relatados até se / quando Sandcastle Help File Builder processa os comentários.
  • A sintaxe única funciona se houver mais de um método com o mesmo nome.
  • Não há destaque de sintaxe ou de apoio editor para esta sintaxe.
Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top