Mail Archives: djgpp/1997/03/13/14:28:47
Dim Zegebart wrote:
> Hi,
> I'm using RHIDE and DJGPP for at least half of the year.
> It's very helpful in my job ;) Thanks for a great work !!!
>
> Everybody knows what most difficult part of programming is ...
> writing good documentation ;) Also, we have an exelent tool
> like info. And also we have Alt-F2 in RHIDE to view
> function's list in current module. So, my idea is create
> info editor inside RHIDE. For example : you press Alt-F2,
> pick function and type some description. When all functions are
> described you press 'Write info file' button and .inf file appears
> on you hard disk ;)
>
> Robert, any comments ?
Hi Dim, good idea.
I have a solution for that, perhaps could be good:
As the editor have the pseudo-macro facilitie, we can define a macro for the
comment of the functions (there are allready one draft triggered with /*).
The the mechanism could be:
1) Write the function.
2) Go to the start of the function.
3) Write /*Ctrl+Space
4) Fill the fields of the comment (we can create some standard field, like
Name, Parameters, Return, Belongs to, etc).
5) With that you have heavily commented your code (I made that in for the main
class of the editor, over than 10000 lines).
6) Call a magic function from the menu (to be implemented, but easy to do
because we can use the "defined fileds").
7) The editor generates a file, then you join the files created from different
sources and with that create the .info file.
The magic function can have 2 options:
1) Generate an standalone file, that means a whole source for a .info file.
2) Generate just a body allowing to join more than one of these bodies in one
of the files created by (1).
Additionally (is more complex) we can make the user to choose what file he
want to scan or perhaps scan the whole project (doesn't seems to be the better
but is more easy).
Please, all make comments, because this feature isn't so hard to implement
and the benefit could be very good.
SET
--------------- 0 --------------------------------
Salvador Eduardo Tropea (SET).
Address: Curapaligue 2124, Caseros, 3 de Febrero
Buenos Aires, (1678), ARGENTINA
TE: +(541) 759 0013
- Raw text -