Fórum Comentário no método #3923
24/03/2009
Boa tarde...
Gostaria de saber como eu coloca comentários no método, por exemplo, nos métodos da framewrok DotNet, exemplo crio uma instância do tipo String nomevariavel
Ao digitar nomevariavel e depois o '.' e ele lista os métodos, ao lista e você for passando pelos métodos, ao lado aparece um resumo do que o método faz e além disso seria o seguinde, ao selecionar um método por exemplo Format, existe opções de parâmetros, ele informa um resumo destes parâmetros também, como faço isso para meus métodos ??
Att,
Vinicius Climaco.
Posts
Vinicius,
Se entendi bem o que vc quer, comentarios é so colocar //, tipo:
// comentario
O String.Format é usado da seguinte forma:
string teste = String.Format("Valor do primeiro parametro = , valor dp segundo = ", param1, param2);
Vc usa as chaves para concatenar dentro de uma string os valores que vc quer.
Começa do 0 (zero) e vai ate onde precisar, sem problemas.
Abraços
Att
Luiz Maia
24/03/2009
Vinicius Climaco
Veja bem, acho que não entendeu, eu sei como incluir comentários...
estou querendo saber aquele resumo, instruções e sumário para meu métodos e parâmetros igual a framework DotNet implementa.
Aguardo...
So usar o summary.
Basta digitar /// (tres baras) ai aparece os parametros a serem preenchidos a ssim aparececem no resurso Intellisence quando digitar um ponto no metodo.
Veja um exemplo:
/// <summary>
/// Este metodo faz bla bla.
/// </summary>
/// <param name="primeiroParametrno">Aqui entra o parametro bla.</param>
/// <returns>O Método retorna um xml contendo o status de execução bla bla bla.</returns>
Abraços
Att
Luiz Maia
24/03/2009
Vinicius Climaco
Boa tarde,
nesta linha você falou em
/// <param name="primeiroParametrno">Aqui entra o parametro bla.</param>
name seria o que ? o nome do parametro ? digo metodo Calcular(double prUM, double prUM)
ai ficaria assim:
/// <param name="prUM">Primeiro valor do parâmetro.</param>
/// <param name="prUM">Primeiro valor do parâmetro.</param>
Seria isso ? E quanto as outras tags o que elas fazem, existem diversas... gostaria de saber o que cada uma faz...
Att,
Vinicius Climaco.
Isto mesmo Vinicius,
Para cada parametro vc devera acrescentar uma nova linha com a descrição do mesmo.
E a linha referente ao return, é o retorno de seu metodo, tipo, ele pode retornar uma String, int, DataTable e ate mesmo ser um void.
Veja um exemplo:
/// <summary>
/// Método orquestrador que realiza consultas nos web services do IPC e retornam os dados de Pessoa Jurídica (PJ) necessários para o WSG.
/// </summary>
/// <param name="numeroCNPJ">Número do CNPJ</param>
/// <param name="codigoUsuario">Código do usuário conectado na rede.</param>
/// <returns>EstruturaConsultarPessoaJuridica</returns>
/// <remarks>Data de Criaçao:17/11/2008 - Jonas Fernandes- Rumo Info</remarks>
public EstruturaConsultarPessoaJuridica ConsultarPessoaJuridica(string numeroCNPJ, string codigoUsuario)
{
Abraços
Luiz Maia
