📄 faq.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head lang="en">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en">
<meta name="author" content="Gerold Veith">
<meta name="description" content="Frequently Asked Questions on JADD - Just Another DelphiDoc.">
<meta name="keywords" content="FAQ, Frequently Asked Questions, Help, DelphiDoc, KylixDoc, JADD, Just Another DelphiDoc, DelphiDoc">
<meta name="DC.Language" content="en">
<title>
Frequently Asked Questions - FAQ - of JADD - Just Another DelphiDoc
</title>
</head>
<body lang="en">
<p align=center>
<!-- local -->
<a href="http://sourceforge.net/"><img
src="sflogo.png"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
<!-- /local -->
<!-- public - -!
<a href="http://sourceforge.net/"><img
src="http://sourceforge.net/sflogo.php?group_id=113456&type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
<!- - /public -->
Homepage: <a href="http://delphidoc.sourceforge.net/">http://delphidoc.sourceforge.net/</a><br>
Project-Page: <a href="http://sourceforge.net/projects/delphidoc/">http://sourceforge.net/projects/delphidoc/</a><br>
</p>
<br clear="all">
<h1>JADD - Just Another <em>DelphiDoc</em></h1>
<h2>FAQ - Frequently Asked Questions</h2>
This FAQ has just been started and doesn't contain much, you're welcome to
ask some question to let them be added to the FAQ.
<h2><a name="TOC">Table of Contents</a></h2>
<ul>
<li>General
<ol>
<li><a href="#TOC">Nothing so far.</a></li>
</ol>
</li>
<li>Parser
<ol>
<li><a href="#TOC">Nothing so far.</a></li>
</ol>
</li>
<li>Documentation
<ol>
<li><a href="#TOC">Nothing so far.</a></li>
</ol>
</li>
<li>Comments
<ol>
<li><a href="#ExtractComments">How to extract comments?</a></li>
</ol>
</li>
<li>Miscellaneous
<ol>
<li><a href="#OtherDelphiDocs">Do you know any other/similar tools
like <em>DelphiDoc</em>?</a></li>
</ol>
</li>
</ul>
<h2>General</h2>
<p>Nothing so far.</p>
<h2>Parser</h2>
<p>Nothing so far.</p>
<h2>Documentation</h2>
<p>Nothing so far.</p>
<h2>Comments</h2>
<h3><a name="ExtractComments">How to extract comments?</a></h3>
<p>Comments are always taken from directly above the declaration of an
identifier and from the same line. For files it is the first comment
in it. There are
<a href="options.html#OptionTSourceCommentExtractor">several
options in the extractor</a> to modify the extraction.<br>
For files you can also use the first comment after the first
statement, allowing to skip copyright-notices etc.. Similar you can
indicate if the comments should be extracted from the first (forward-)
declaration or the final one. To extract the content of comments and
skip useless separators you can remove all leading and trailing stars
"<code>*</code>" or even use powerful Regular Expressions. Instead of
stars also other markers can be used.<br>
The other objects contain further options to change the handling of
the comments, so be sure to also read through them.</p>
<p><em>DelphiDoc</em> supports a range of
<a href="comments.html#Sections">sections</a> and
<a href="comments.html#InlineCommands">commands</a> in comments. You
can define the special characters (using for instance
"<code>@</code>" instead of "<code>~</code>" like in similar tools)
and also rename sections. You can also disable the parsing
of comments and just insert them as-is, or even ignore comments
completely and just generate the cross-references with
<em>DelphiDoc</em>.</p>
<p>If that isn't enough for you, or just your comments are at a complete
different position (even outside the source-code, like in an ini-file
or data base) you may want to change <em>DelphiDoc</em> and compile it
yourself. In that case take a look in the file
<code>\Generator\CommentHelper\USourceCommentExtraction.pas</code> at
the class <code>TSourceCommentExtractor</code>. You can either change
the two methods <code>Comment</code> and <code>CommentOfFile</code> or
create a new sub class and override them.</p>
<p><a href="#TOC">TOC</a></p>
<h2>Miscellaneous</h2>
<h3><a name="OtherDelphiDocs">Do you know any other/similar tools like
<em>DelphiDoc</em>?</a></h3>
<p>There are several other tools that are more or less similar to
<em>DelphiDoc</em>, I'm by far not the first that had the idea. But at
the time I started to write <em>DelphiDoc</em> there were not other
free tools that would satisfy my needs. It's getting better, but as
far as I know there is still no program that would provide all needed
features. But, well, of course the own program written for the own
needs always fits the best. And my "needs" are also not that important
because I used <em>DelphiDoc</em> really only once, and that was in
spring 2003 only a few month after I started programming it, only to
document my program for the intermediate diploma at the
<a href="http://www.fh-wedel.de/englisch/index.html">University of
Applied Sciences Wedel</a>.</p>
<p>The main problem of most programs still seems to be, they are to close
to the original JavaDoc and only generate HTML, well, and slightly
changed that to also compile it to HTML Help. If that is what you
want: no problem, if you want another format you've got a problem.
Another thing may be the parsing of the source code. That again
depends on what you want and need. Simply listing all identifers in
the source should be no problem. <em>DelphiDoc</em> parses the source
like the compiler, so it has additional information for an extensive
cross-reference, like used identifers etc., but it also means, that
identifiers, that are not compiled due to conditional compiling, won't
be documented. In both ways you might have a piece of source code that
can't correctly be parsed by one of the programs.</p>
<p>As said, it all depends on what you want. Best thing is just to try
the different programs and their options and see which fits best.</p>
<dl>
<dt><a href="http://dephicodetodoc.sourceforge.net/">DelphiCodeToDoc</a></dt>
<dd>This is a nice program that wasn't around when I started. Maybe
if it had, I wouldn't have written <em>DelphiDoc</em>.<br>
The <acronym title="Graphical User Interface">GUI</acronym> of
the program is about a million times nicer than the old one of
<em>DelphiDoc</em> (but I had a progress window :-P), but now I
hope I narrowed the gap considerably with the new GUI. But on the
other hand, DelphiCodeToDoc has far less options to squeeze onto
a form. Its GUI can use several different languages, but the
documentation itself is still fixed on english. The documentation
can also only be generated in HTML and, recently added, HTML
Help. The program seems now about to leave the beta phase, it
can for example almostly parse <em>DelphiDoc</em>'s source (and
does now also give positions of the errors!).<br>
Still a nice project that should be tracked.</dd>
<dt><a href="http://www.softconsult.se/delphidoc.html">DelphiDoc (SoftConsult)</a></dt>
<dd>This is also very nice project, the best I found before I
started. Sadly even with my other program it got errors. And it's
closed source and it seems not further developed, so I couldn't
fix it. But its free, and regulary you will find it searching for
something like DelphiDoc, so you won't miss it in this list.</dd>
<dt><a href="http://www.soletta.com/stories/2002/11/23/wheresSoletta.html">DelphiDoc (Soletta)</a></dt>
<dd>This is a different story. This DelphiDoc wasn't free, you had to
pay for it (IIRC the first versions had been free). Nowadays it's
not further developed, and it seems the creator lost the source.
But searching for DelphiDoc you will find the name Soletta
everywhere, mainly to download the evaluation version from very
out-dated shareware services.</dd>
<dt><a href="http://pasdoc.sourceforge.net/">PasDoc</a> /
<a href="http://www.zeitungsjunge.de/delphi/pasdoc/">DIPasDoc</a></dt>
<dd>Not the most active projects, but probably one of the oldest.
As the name implies not only for Delphi but for other dialects of
Pascal, too. Exports to HTML, HTMLHelp and (again)
L<small><sup>A</sup></small>T<small><sub>E</sub></small>X,
supports generating RTF files from the LaTeX output.</dd>
<dt><a href="http://www.autosci.com/">Pro-Analyzer</a></dt>
<dd>This is not a documentation tool, but an analyzer. It generates
detailed reports about the source code. Something you won't find
anywhere else, but that doesn't come for free. And some of the
reports are also obsolete because the Delphi compiler does its
tests automatically.</dd>
<dt><a href="http://essmodel.sourceforge.net/">ESS Model</a></dt>
<dd>This is also not a documentation tool, but an UML reversing tool
for Delphi and Java. Once a commercial product it was released
with source for free (as in speech, i.e. the GPL). It parses the
source code and generates UML diagrams from it. It can also
export the UML model in an XMI file that can be read by
<a href="http://argouml.tigris.org/">ArgoUML</a>, a Java-based
open-source UML-tools. I was very impressed by this tool, what
led me to implementing these both key features also in this
<em>DelphiDoc</em>. This project is also no longer actively
developed.</dd>
</dl>
<p><a href="#TOC">TOC</a></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -