quarta-feira, 17 de março de 2010

XMLDoc - Uma excelente alternativa para comentar o seu código fonte

Olá, tempos atrás, eu e o meu colega Wanc procuramos uma forma efetiva de comentar o código fonte.

Eis que nos surge o XMLDoc.

Basicamente, você usa algumas tags especiais antes do elemento que esta sendo comentado.

Consegui identificar alguns, como no exemplo abaixo:

unit Unit1;

interface

uses
  Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
  Dialogs;

type
  TForm1 = class(TForm)
    Button1: TButton;
    procedure Button1Click(Sender: TObject);
  private
    ///  
    ///  Rotina responsável por inverter uma palavra
    ///    Teste -> etseT
    ///  
    ///  Palavra que será processada///    
    ///  A inversão de uma palavra consiste em escrevê-la de trás para frente
    ///    Respeita a caixa utilizada
    ///  
    ///  
    ///  A rotina carece de melhorias no desempenho
    ///  
    ///  
    ///  Retorna a palavra invertida
    ///  
    ///  
    ///  Caso haja um erro, é dipsrado um 
    ///  
    function InverterFrase(psEntrada: string): string;
    { Private declarations }
  public
    { Public declarations }
  end;

var
  Form1: TForm1;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
begin

end;

function TForm1.InverterFrase(psEntrada: string): string;
begin

end;

end.

Observe que esta função funciona apenas se a unit estiver adicionada ao projeto.

Veja como fica no Help Insigth:

Um comentário:

primuks disse...
Este comentário foi removido pelo autor.

Minha lista de blogs