Como corrigir automaticamente documentação xml de métodos
-
11-09-2019 - |
Pergunta
No código abaixo na documentação xml existe incompatibilidade entre os nomes de parâmetros em argumentos de método e nome de parâmetros na documentação xml. Existe alguma maneira de auto corrigir a assinatura de documentação xml ou qualquer recurso previsto no ReSharper para auto corrigir a documentação xml.
#region Get Images
/// <summary>
/// Get Images
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages()
{
return GetImages("");
}
/// <summary>
/// Get Images
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(string imageType)
{
return GetImages(0, imageType);
}
/// <summary>
/// Get Images
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId)
{
return GetImages(imageId, "");
}
/// <summary>
/// Get Images
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId,string imageType)
{
return null;
}
#endregion
Por exemplo, eu quero o método com documentação xml como este:
/// <summary>
/// Get Images
/// </summary>
/// <param name="imageId"></param>
/// <param name="imageType"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId,string imageType)
{
return null;
}
#endregion
Solução
GhostDoc vai fazer isso por você. Após a instalação você começa um novo item de menu de contexto em 'Documento este' VS (e um atalho de teclado correspondente).
Se há comentários XML estão presentes, ele irá adicioná-los. Se eles já estão presentes, eles devem ficar atualizado como você exige.
Outras dicas
A única forma que conheço para "auto correta" xml com R # é excluir a documentação xml existente e hit /// novamente. Desculpe eu não tenho uma resposta melhor.
Eu acredito que não é possível porque R # não o que precisa para corrigir a assinatura de documentação xml ou método.