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.

?
?

Frank Church hat am 19. April 2011 um 12:51 geschrieben:

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?

Mattias
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lazarus.freepascal.org/pipermail/lazarus/attachments/20110419/515bcb73/attachment-0001.html>

2011/4/19 Mattias Gaertner

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.

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?

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 ?

fpdoc, obviously.

Michael.

As a personal opinion, I would like to see that in fpdoc. For example introducing a checksum field, for each documented procedure. Then you could always get a list of modified, since last documentation functions.

Obviously it be nice if the checksum was not sensitive to changes in whitespace only.

It would not show you a diff, of what was changed, but that can be found via svn and co (Maybe another field, indicating which revision a file had, at the time of documenting....

Martin

It would not show you a diff, of what was changed, but that can be found via svn and co (Maybe another field, indicating which revision a file had, at the time of documenting....

Git comes with a nice listing of a file's history, which ranges of lines have been changed, by whome etc., since the file was checked in.

But of course git doesn't have a notion of procedures, nor has any other versioning system I know of.

DoDi

Borland/CodeGear/Embardcadero Developer Studio cames with a tab that stores last saves on currentsaves. It all BDS creates a directory called __history that stores these files. Should be a good idea if lazarus do something like?
________________________________
William de Oliveira Ferreira
Bacharel em Sistemas de Informa??o

2011/4/19 Hans-Peter Diettrich :

William Oliveira Ferreira wrote

Borland/CodeGear/Embardcadero Developer Studio cames with a tab that stores last saves on currentsaves. It all BDS creates a directory called __history that stores these files. Should be a good idea if lazarus do something like?

Then you can have TB's of such history files in few months ?

zeljko

William Oliveira Ferreira wrote

called __history that stores these files. Should be a good idea if lazarus do something like?

That's just duplication of what VCS or SCM systems already do (well the good ones at least). I can search my git repositories for a patch/commit containing a snippet of code etc without problems. I can search the repository history for text in the commit logs/comments. 'git blame' can instantly show me who last worked on each line of code in a unit. 'git log' or 'gitk' shows the full history of the repository, branches, merges etc and how they tie together etc..

Bottom line, use the correct SCM for the job. ;-)

Regards,
- Graeme -

William Oliveira Ferreira wrote

Borland/CodeGear/Embardcadero Developer Studio cames with a tab that stores last saves on currentsaves. It all BDS creates a directory called __history that stores these files. Should be a good idea if lazarus do something like?

With the right configuration Lazarus can do that already (at least it seems so according to the items in "Settings => Backup")

Regards,
Sven

Ow yeah! sorry! i forgot that!
________________________________
William de Oliveira Ferreira
Bacharel em Sistemas de Informa??o

2011/4/20 Sven Barth :