Você está aqui: Principal » Lista Completa de Tutoriais

Sobre este Tutorial

Autor:	Mauricio Pereira Borges Junior
Data:	20-12-2005
Categoria:	Programação
Assunto:	C# - BÁSICO
Visitas:

Criando HELP

Visual Studio.Net 2003 usando NDOC.

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.

Praticando

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.

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.

Livros:

Mauricio Junior

www.aspneti.com

www.ascompras.com

LISTA DE TODOS OS TUTORIAIS DISPONÍVEIS

LIVROS CAMPEÕES DE VENDA NO SITE

Cursos Online com Certificado e Suporte à Dúvidas

CURSOS ONLINE COM CERTIFICADO - INDICADOS POR JÚLIO BATTISTI EM PARCERIA COM CURSOS 24 HORAS
AdministraÇÃo
Administração Contábil e Financeira Administração de Empresas Administração do Tempo Aprenda a Falar em Público Chefia e Liderança Departamento Pessoal Empreendedorismo Gestão da Qualidade Gestão de Compras	Gestão de Projetos Gestão Escolar Gestão Hoteleira Gestão Pública Logística Matemática Financeira HP 12C Planejamento Estratégico Qualidade de Vida no Trabalho
COMUNICAÇÃO E MARKETING
Administração de Empresas Aprenda a Falar em Público Comércio Exterior Empreendedorismo Escrita e Redação Etiqueta Social e Empresarial Jornalismo Online Marketing Pessoal	Marketing Social Planejamento Estratégico Produção de Eventos Propaganda e Marketing Sucesso Profissional Técnicas de Vendas Telemarketing
CONCURSOS PÚBLICOS
Conhecimentos Bancários Gestão Pública Memorização e Leitura Dinâmica	Noções Gerais de Direito Raciocínio Lógico
CONTABILIDADE E ECONOMIA
Administração Contábil e Financeira Administração de Empresas Bolsa de Valores Comércio Exterior	Conhecimentos Bancários Contabilidade Básica Finanças Pessoais Matemática Financeira HP 12C
DIREITO
Assistente Social Departamento Pessoal	Gestão Pública Noções Gerais de Direito
GESTÃO E LIDERANÇA
Administração de Empresas Administração do Tempo Aprenda a Falar em Público Chefia e Liderança Empreendedorismo Etiqueta Social e Empresarial Gestão de Compras Gestão de Projetos Gestão Escolar	Gestão Hoteleira Gestão Pública Marketing Pessoal Memorização e Leitura Dinâmica Negociação Propaganda e Marketing Recolocação Profissional Secretariado Executivo Sucesso Profissional
INFORMÁTICA
Access 2007 ASP AutoCad 2D AutoCad 3D CorelDraw Excel 2007 Flash Linux MS Project 2007	Photoshop PowerPoint 2007 Raciocínio Lógico Redes e Noções de Hardware Segurança na Internet Webmaster Windows 7 Word 2007 Word e Excel
MEIO AMBIENTE
Educação Ambiental Guia de Turismo	Marketing Social Reciclagem e Energias Renováveis
PEDAGOGIA
Bullying Distúrbios de Aprendizagem Educação Ambiental Educação de Jovens e Adultos Educação Especial	Educação Infantil Escrita e Redação Gestão Escolar Saúde Emocional do Educador
ProfissionalizanteS
Administração de Empresas Assistente Social Comércio Exterior Departamento Pessoal Educação de Jovens e Adultos Educação Infantil Enfermagem Fotografia Digital Gestão da Qualidade Gestão de Compras Guia de Gastronomia	Guia de Turismo Jornalismo Online Logística Produção de Eventos Recepcionista de Hotel Recrutamento e Seleção Secretariado Executivo Segurança do Trabalho Técnicas de Vendas Telemarketing Webmaster
RECURSOS HUMANOS
Administração de Empresas Departamento Pessoal Gestão Pública	Qualidade de Vida no Trabalho Recrutamento e Seleção
SAÚDE
Assistente Social Bullying Enfermagem	Primeiros Socorros Saúde Emocional do Educador Segurança do Trabalho
TURISMO E HOTELARIA
Gestão Hoteleira Guia de Gastronomia	Guia de Turismo Recepcionista de Hotel

CURSOS ONLINE COM CERTIFICADO - INDICADOS POR JÚLIO BATTISTI EM PARCERIA COM BRAVA CURSOS
INFORMÁTICA
Curso de Digitação Formatando e Instalando Computador Excel para Iniciantes Curso Compre no Ebay Informática Educativa Curso de Linux	Segurança na Internet Montagem e Manutenção de Computadores Curso Remoção de Vírus Curso Ubuntu Instalação Linux - Ubuntu
AdministraÇÃo
Gestão de Projetos e Empreendedorismo Benefícios da Previdência Curso HP 12C Matemática Financeira Curso Análise Salarial	Processo de Elaboração de Questionário Excelência no Atendimento ao Cliente Logística do Transporte Licitações e Contratos Administrativos
Profissionalizante
Adestramento Canino Como fazer pesquisa Científica e Monografia Curso de Corte e Costura Supervisor de Telemarketing Balconista de Padaria Curso Educação Infantil	Recepcionista e Secretaria Velas Artesanais Relações Interpessoais Curso de Arbitragem Bullying e Cyberbullying Capacitação de Tutores em EAD
EstÉtica
Curso de Massoterapia Curso de Depilação Drenagem Linfática Curso de Maquiagem Limpeza Turbinada de Pele	Alisamento e Relaxamento Capilar Curso de Etiqueta SPA de Vinhoterapia na Estética Facial Curso de Shantala Introdução à Colorimetria Capilar
Pessoal
Curso de Caligrafia Memorização Chefia e Liderança Curso Falar em Público Curso Bases Neurológicas Leitura Dinâmica Planejamento de Projeto Pessoal Reforma Ortográfica	Como Passar em Concursos Públicos Direção Defensiva Administração do Tempo Curso de Redação Curso de Meditação Como Passar no Vestibular Atualização Gramatical
NegÓCIOS
Relações Humanas e Ética Profissional Marketing e Vendas Diretas	Persuasão em Vendas
Entretenimento
Curso de Mágica
SaÚde
Primeiros Socorros Curso de Fitoterapia Curso de Aromaterapia Medicina Alternativa Plantas Medicinais	Técnicas básicas de Enfermagem O Trabalho do Agente Comunitário de Saúde Ergonomia - Postura Correta em Frente ao Computador Ética Profissional - Ênfase em Radiologia Adolescência: Visão Saúde do Assunto
Meio Ambiente
Curso Gestão Ambiental Jardinagem e Paisagismo	Curso de Reciclagem Curso de Bonsai
MÚsica
Curso de Violão
NutriÇÃo
Higiene e Manipulação de Alimentos Congelamento de Alimentos	Culinária Básica Culinária Intermediária
RelaÇÕes Humanas
Curso Gestão de Pessoas Departamento Pessoal Desenvolvimento Pessoal Empresarial Curso de Telemarketing Curso Dinâmica em Grupo Rescisão Contrato de Trabalho Folha de Pagamento na Prática	Atendimento ao Cliente Adm. da Empregada Doméstica Curso de Homolognet Recursos Humanos - Férias Recursos Humanos - 13° Salário Registro de Empregados
Web Master
Curso de HTML Curso de WordPress	Curso de HTML5
Designer GrÁfico
Curso de Corel Draw Efeitos Especiais com InDesign CS5	Efeitos Tipográficos com InDesign CS5

CURSO EM FORMATO DE VÍDEO-AULA

EXEMPLOS PRÁTICOS PASSO A PASSO COM SOM E IMAGEM

Clique no curso para informações detalhadas

Curso

Duração

Informações

ACCESS

Vídeo Aula: Access 2007 - Consultas - Curso Completo e Prático

4:30h

LOJA DE LIVROS

VÍDEO-AULAS

E-BOOKS/CURSOS

CURSOS ONLINE COM CERTIFICADO

CURSOS COMPLETOS EM CD

CD-01

CD-02

CD-03

CD-04

CD-05

CD-06

CD-07

CD-08

CD-09

CD-10

CONTATO

Você está aqui: Principal » Lista Completa de Tutoriais

Sobre este Tutorial

Criando HELP

Visual Studio.Net 2003 usando NDOC.

:: Tutoriais Relacionados

CURSOS
COMPLETOS EM CD