Menu

Simple Inline comment problem

Anonymous
2004-09-15
2012-07-18
  • Anonymous

    Anonymous - 2004-09-15

    When I comment out a variable:

      var1 : String;
      //var2 : String;
      var3 : String;  //sample var

    it is parsed as description to the next var

    Field             Description

    var3             var2 : String;

    even if it has an own End of line Inline commnet!

    End of line Inline commnet should has bigger preference.
    Or it were most desirable to have an option to turn off the Simple Inline comments at all, to avioid this situations.

     
    • TridenT

      TridenT - 2004-09-15

      You should simply configure the JavaDoc Inline prefix as '/' and not #0 ('/' is the default value).
      So javaDoc comment must be start with ///

      ex:
      var1 : String;
      //var2 : String;
      var3 : String; ///sample var3

      It should work well now !

       
    • Nobody/Anonymous

      I have read the manual and others documents explaining how to use the DelphiCodetoDoc. However I have tried use without success. I have created a simple program using just one button.

      The code that I have used:

      unit Unitunica;
      {
      @autor roberto
      *Description descricao
      }
      interface

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

      type
      TJanela = class(TForm)
      /// Botao para mudar a cor da janela
      Botao: TButton;
      procedure BotaoClick(Sender: TObject);
      private
      { Private declarations }
      public
      { Public declarations }
      end;

      var
      Janela: TJanela;

      implementation

      {$R *.dfm}

      procedure TJanela.BotaoClick(Sender: TObject);
      begin
      ///aplica o vermelho na janela
      color:=clred;
      end;

      end.

      I can see just this result:

      Member
      BotaoClick

      Visibility
      PUBLISHED

      Related Class
      TJanela

      Description
      #No TAG found in source code#

      Additionnal Comments
      aplica o vermelho na janela

      Source code
      procedure BotaoClick ( Sender : TObject )

      Parameters
      Parameter Description
      Sender : TObject #No TAG found in source code#

      Links
      #UnderConstruction#

      Could you help me, please?!

      Roberto
      Brazil

       
      • TridenT

        TridenT - 2005-03-02

        You should write the unit as this:
        ------------- START_CODE --------------------

        {
        @autor roberto
        * descricao
        }
        unit Unitunica;

        interface

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

        type
        TJanela = class(TForm)
        Botao: TButton; /// Botao para mudar a cor da janela
        procedure BotaoClick(Sender: TObject);
        private
        { Private declarations }
        public
        { Public declarations }
        end;

        var
        Janela: TJanela;

        implementation

        {$R *.dfm}

        procedure TJanela.BotaoClick(Sender: TObject);
        begin
        ///aplica o vermelho na janela
        color:=clred;
        end;

        end.

        ------------- END_CODE --------------------

        or, just have a look to the Source code.
        try files inside Sources\process\extract
        For example, open uDocProject.pas, it will helps you.

        I hope this tool will do what you need.
        TridenT

         

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.