> Juarez Rudsatz <juarez@nowhere.com> wrote
in
> news:Xns924D92B1EB48Djuarezcorreiocom@63.105.9.61:
>
>
> The problem is (3)
yet. I don't sure syntax proposed is
>
> non-ambiguos
>
> or easy to parse. But the problems must be stripped or remodeled. For
> > example, the tag parameters in the proposed syntax are
ugly.
> >
>
> I have seen the form is
used in mail specification for parameters:
>
> MIME-version:
1.0
> MIME-encoding: 7 bit
>
> Enabling
this "subtags" could be a good form of dealing with
> parameters for
comments ? What do you think ? There are another good way ?
>
>
E.g.:
>
> /**
> * copyright: Pavel "EvilOne"
Minayev
> * copyright-date: 2001
> * license :
GPL
> * license-site : http://www.gnu.org/copyleft/gpl.html> * version : 2.95.0.3
> * version-status :
stable
> * bug : Windows 9x does not pass the correct memory
used
> * bug-severity : low
> **/
Looks good, although I don't know how often I'd use
it. It'd be good for project programming. I guess if its there... I'd be nice if
there was some central base for bug produced by the gen (perhaps optional). This
way you could quickly find bugs to attempt to fix.
How about,
* bug-fixed : Windows 9x does not pass the correct
memory used
for fixed bugs (simply add the -fixed to
bug)
Also bugs should have optional titles as it makes
things easier to fix if bugs have long definitions.
* bug-name : Win9x memory error
And also how about a company logo that will be
placed on every page (next to copy write)
* logo : logo.gif
And a
* Updated : 2002.10.10
Although that could be determined though the file's
attributes by default for the class; file dates are not always a correct
indication of an update and not every method in a class will be updated
every time.
On another note
I'd think it would be also be nice to have the gen
program produce html documents from a html templates. Of corse there would be a
default one that comes with the program that you could customise.
You'd probably have these templates:
Index.htm - Frame based page
SideBar.htm - Hierarchical side bar
Class.htm - Class layout template
Method.htm - Methods layout
Property.htm - Property layout
Of course more though needs to be put into
that.
Basically the generation program would copy the
files as needed and look for special tags in the files to replace with code from
the files. A bit of though will have to go into how list will be produced.
Perhaps an XML derivative (without need for closing except on lists) could be
used as tags in the html template files.
For example
(Although I don't like the extra typyness of xml it
could be used for lists.)
...Sample html template code for
Class...
//Other html code...
[CLASS]
<H1>[CLASS NAME]</H1>
Version : <B>[CLASS
VERSION]</B>
[METHOD LIST]
<H2>[METHOD NAME/]</H2>
[COMMENT/]
<I>[AUTHOR/]</I>
<TAB>Version:
<B>[VERSION/]</B></TAB>
[/METHOD LIST]
[/CLASS]
//Other html code...
The gen would search for the square brackets (I
don't care what is used, except <> will be confided with html) and
replace them with actual comments.
This way pages could be enhanced for the particular
operation. I know it's good to have a common standard, but what if - say a
company want to make all the pages in the same style as there webpage. It would
be far easier to do this with template html. Also this would mean the layout of
the gen could be improved over time. If I had time (an I don't) I'd program
this myself in D as it doesn't look like a very tough job (but I could be
wrong).