Olá pessoal, meu nome é Mauricio Junior e estou disposto a publicar este artigo para ajudar todos os desenvolvedores que trabalha em equipe, fabrica de software ou mesmo distribui o código fonte. Hoje em dia, desenvolvo vários tipos de frameworks para empresas particulares e públicas que desejam uma documentação ou mesmo um help para ajudar a outros desenvolvedores quando ocorrer alguma alteração. Essa idéia de documentar os códigos que desenvolvo é um costume muito bom para que depois de muito tempo o mesmo código possa estar sendo usado ou alterado por outra pessoa que nem mesmo participou do projeto no começo do desenvolvimento.
Existe uma ferramenta que pode estar gerenciando e criando documentação de todo o projeto, ou seja, do código fonte que foi desenvolvido. O Visual Studio.Net 2003 possui também uma ferramenta que gera páginas html. É uma boa ferramenta, mas não mostrarei como usá-la, essa outra ferramenta NDOC pode gerar paginas html ou mesmo .chm que é a extensão de um help.
Para utilizar e instalar o NDOC, basta acessar o site http://ndoc.sourceforge.net/ ou http://sourceforge.net/project/showfiles.php?group_id=36057 para fazer download e instalar o mesmo em sua máquina.
Depois de instalado, agora será com o desenvolvedor ou programador. Todo o código que for digitado dentro da ferramenta Visual Studio.Net 2003 é ótimo se for documentado; é uma boa prática de programação.
Antes de tudo, criei um projeto web no VS 2003 chamado NDoc2003. Criei uma classe chamada NDoc.cs para mostrar a todos como funciona a ferramenta NDOC. Desenvolvi apenas um método chamado VerificarStatus() que retorna uma String qualquer. A figura mostra como ficou o código digitado.
Apenas um for de zero a dez armazenando em uma variável string para retornar depois. Perceba que a classe está comentada dentro das tags summary. O código da classe é bem simples e de fácil entendimento.
Página seguinte  |
|
|
|
Enviado por