Criando HELP (página 2)

using System;

namespace NDoc2003

{

      /// <summary>

      /// o código desenvolvido.

      /// </summary>

      public class NDoc

      {

            private String VerificarStatus()

            {

                  string retorno = null;

                  for (int i=0; i > 10; i++)

                  {

                        retorno += "meu retorno " + i;

                  }

                  return retorno;

            }

      }

}

Esse comentário dentro da tag summary é muito importante para gerar depois o help com index e pesquisa. Depois de criado o método dentro da classe NDoc.cs, fui ao início método ou uma linha antes, clique três vezes as barras ( /// ), que, a ferramenta Visual Studio.Net 2003 já coloca as tags necessárias para ser comentadas.

Pronto, o método foi comentado descrevendo o que ele faz, quais os métodos estão referenciando e o tipo de retorno. Depois de comentado, cliquei com o botão direito em cima do projeto e fui para a opção propriedades para definir um xml de comentário.

Logo depois, irá aparecer uma outra tela menor chamada Property Pages, existe uma pasta do lado direito com o nome Configuration Properties e por último, dentro dessa opção existe um campo chamado XML Documentation File, coloquei um nome na frente do campo para sair um arquivo xml depois do projeto compilado.

O nome que escolhi foi NDocXML.xml para a saída dos comentários feitos dentro do projeto. É bastante interessante isso no Visual Studio.NET; todas as saídas do projeto, estará dentro deste xml. Depois clique em APLICAR e depois em OK.

Compilei o projeto e o mesmo gerou um arquivo de acordo com o que foi solicitado na tela de properties. Segue o mesmo dentro da pasta do projeto.

Depois de instalado, o NDOC fica em seu menu iniciar. Vá até a opção 1.1 e clique para o programa começar a executar.

Cliquei no programa e abriu uma tela com algumas funcionalidades. É bem simples utilizar o mesmo.

Existe o botão ADD do lado direito, no começo do programa. Clicando, o mesmo abrirá uma outra tela menor que serve para indicar ou referenciar a dll do projeto.

Esse campo Assembly, é para referenciar a DLL do projeto. Clique no botão com três pontinhos do lado direito ( ... ) e indique a DLL do seu projeto depois de compilada. Depois disso clique apenas no Ok.

Depois de tudo isso estamos quase lá, para gerar o nosso help. É simples depois fazer uma configuração para saber se queremos um help ou apenas documentos web ou help e documentos web. Ainda na tela principal do NDOC, é necessário mudar alguns parâmetros ou configurações.

No meu caso, estou querendo que a aplicação crie apenas o help do código que desenvolvi dentro do projeto, com isso, na opção OUTPUTTARGET escolhi a o valor HTML HELP. É só clique no botão ao lado de salvar chamado BUILD.

Depois disso, o build foi completo gerando um arquivo .chm dentro do diretório indicado.

Prontinho, depois disso é só verificar o arquivo .chm.

Espero ter ajudado.