[Lazarus] CodeTools facility for documenting source code?

Michael Van Canneyt michael at freepascal.org
Tue Apr 19 15:04:13 CEST 2011



On Tue, 19 Apr 2011, Frank Church wrote:

> 
> 
> 2011/4/19 Mattias Gaertner <nc-gaertnma at netcologne.de>
>
>        
>
>        
> 
>
>       Frank Church <vfclists at gmail.com> hat am 19. April 2011 um 12:51 geschrieben:
> 
>
>             Is there a codetools facility that can help you annotate changes to your functions,
>             and also help you create some kind of documentation block whenever you create a new
>             function or procedure?
>
>             eg when I want to commit changes to SCM I would like a tool that can list all
>             procedures which have changed and give me the option to jumping to them one by one
>             and noting the changes, then summarize the changes at the beginning of the file
>             itself.
> 
> 
> Not yet.
> 
> Maybe you can be more specific about "which have changed". I guess you mean since last commit to SCM
> (or svn or git ...).
> For this the IDE needs a plugin for the version control system.
> Or do you mean the changes since last save to disk?
>  
> 
> 
> 
> I am looking for something manually triggered that can check what procedures have been modified, or added,
> then I can jump to them one by one and note down my changes.
> 
> I don't need something that is necessarily hooked into my VCS, but something that can diff the procedures
> individually and list those that have been changed.

Yes, but changed relative to what ? What is your point of reference ?
- Last save in IDE
- last commit in VCS ?
- Last time file was loaded ?

> 
> I also need to settle on a docblock style, and this stackoverflow thread is interesting
> http://stackoverflow.com/questions/750810/most-common-docblock-for-delphi-and-or-freepascal-code.
> 
> Are any of the options here preferred by FPC/Lazarus developers?

fpdoc, obviously.

Michael.


More information about the Lazarus mailing list