Microsoft e outros desenvolvedores de software recomendo comentar seu código. Documentação de código ajuda a entender o software que você criar. Também auxilia programadores que podem manter a sua aplicação no futuro. O programa do Microsoft Visual Studio simplifica o processo de documentação do software. Basta adicionar texto XML para o seu código , eo software irá incorporar seus comentários dentro do aplicativo . Depois de compilar o projeto , qualquer pessoa pode ver os seus comentários em uma página web. Instruções
Criar projeto
1
Abra o Visual Studio. Selecione "Arquivo " e " New Project" para abrir a janela "New Project "
2
Clique . "Visual C #" para realçá-lo e clique duas vezes em " ASP.NET Web Application ". < Br >
3
Type " My_Website " na caixa de texto "Nome " e clique em "OK". Visual Studio irá criar um novo projeto chamado " My_Website " e exibir seus arquivos de projeto no painel Solution Explorer. Você vai ver um arquivo chamado " default.aspx " no Solution Explorer. Esta é a página principal do site.
4
Clique na seta ao lado de " Default.aspx " e clique duas vezes em " Default.aspx.cs ". Este arquivo contém código C # da página.
5
duplo clique em " Default.aspx.cs ". Visual Studio irá exibir seu código na janela de código . Você verá um método chamado " Page_Load ", que se parece com isso :
protected void Page_Load (object sender, EventArgs e) {
}
este método é executado quando um navegador carrega a página
6
Adicione a seguinte linha de código entre os dois personagens do suporte : .
int carPrice = computePrice () ;
Esta chama outro método chamado computePrice . Depois de adicionar código, o método será parecido com este :
protected void Page_Load (object sender, EventArgs e) {
int carPrice = computePrice ();
}
7
Adicione o seguinte método após o último caractere suporte do método anterior :
int computePrice privada () { int
precoBase = 20000 ;
int imposto = 1800 ;
int TotalPrice = precoBase + impostos;
retornar TotalPrice ;
}
Este método calcula um total preço usando um preço de base e um imposto sobre vendas. O método não tem comentários a este ponto.
8
Posicione o cursor do mouse sobre " computerPrice private int () { " e digite " ///" (sem as aspas). Pressione " Enter". Visual Studio irá converter os três caracteres de barra para o seguinte bloco de texto :
///
///
///
///
texto que você entra dentro deste bloco será exibido nos comentários XML da página web. Este bloco de código tem um lugar para colocar um resumo do método eo tipo de valor que o método retorna
9
Modifique o bloco de código para que ele se parece com isso : .
///
///Este método calcula um preço total usando um preço de base e um imposto sobre vendas.
///
/// o método retorna o preço total para o método de chamada .
a seção "Resumo " agora descreve o método ea seção " retornos " descreve o tipo de variável que o método retorna .
Ver Comentário Página web
10
Localize o projeto " My_Website " no Solution Explorer " e clique com o botão direito do mouse. Selecione" Propriedades "para abrir a janela "Propriedades" do projeto.
11
Clique na aba " Build" e colocar uma marca de seleção ao lado de " arquivo de documentação XML. "
12
Clique em "Procurar . "Windows Explorer irá abrir e exibir o projeto " Caminho de saída . " Este é o local onde o Visual Studio irá armazenar o projeto compilado .
13
Localize a barra de endereços no topo do Windows Explorer. Você vai ver um caminho de pasta geralmente será parecido com este : .
myUserAccount \\ Documents \\ Visual Studio 2010 \\ Project \\ My_Website \\ mywebsite \\ bin
O caminho real pode ser diferente no seu computador < . br>
14
botão direito do mouse em uma área vazia na barra de endereços e selecione " copiar endereço . " Windows irá copiar o caminho para o clipboard. Clique em "Cancelar " para fechar o Windows Explorer.
15
Mover para o Solution Explorer e clique com o botão direito " My_Website . " Selecionar " Build. " Visual Studio irá compilar o projeto e criar um arquivo XML contendo os seus comentários.
16
Clique no Windows botão "Iniciar " no menu e clique com o botão direito do mouse na caixa "Pesquisar " na parte inferior do menu Iniciar . Selecione " colar". Windows irá colar o caminho que você copiou na caixa "Pesquisar" .
17
Pressione " Enter". Windows Explorer será aberta e exibirá o conteúdo da pasta que contém o projeto compilado .
18
Localize " My_Website.XML " e clique com o botão direito nesse arquivo. Selecione "Open com "e selecione" Internet Explorer ". Internet Explorer irá abrir e exibir uma página da Web que mostra os seus comentários.
