Delphi JavaDoc 解析器

发布于 2024-09-06 02:28:24 字数 509 浏览 7 评论 0原文

我需要用 Delphi 7 解析 JavaDoc（文档）注释语法。它在 Java 世界中被称为“JavaDoc”，但我实际上是为 PHP 做这个，即在一些 PHP 代码中解析 JavaDoc。如果您愿意，可以将其称为 PHPDoc。要了解这些注释是如何工作的，您可以查看 RAD IDE，例如 NetBeans 等。

添加功能的 JavaDoc 示例：

/**
 * Adds to numbers together.
 * @param integer $a The first number.
 * @param integer $b The second number.
 * @return integer The resulting number.
 */
function add($a,$b){
  return $a+$b;
}

请注意，解析器不需要是完整的，即解析所有 PHP 代码。我的意思是，如果它仅接受评论文本作为输入，那就完全没问题了。

干杯，克里斯.

原文

I need to parse JavaDoc (documentation) comment syntax with Delphi 7.
It is well known in the java world as "JavaDoc", but I'm actually doing this for PHP, ie, parsing JavaDoc in some PHP code. Call it PHPDoc if you want to.
To see how these comments work, you can see RAD IDEs like NetBeans etc.

Example of JavaDoc for addition function:

/**
 * Adds to numbers together.
 * @param integer $a The first number.
 * @param integer $b The second number.
 * @return integer The resulting number.
 */
function add($a,$b){
  return $a+$b;
}

Please note that the parser need not be full, ie, parsing all of the PHP code.
I mean, it's perfectly fine if it accepted the comment text only as input.

Cheers,
Chris.

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

鸠书 2024-09-13 02:28:24

您可能会受到 DelpiCodeToDoc 的启发：http://dephicodetodoc.sourceforge.net/
它是 Delphi 的文档系统，使用 JavaDoc 语法。
它并不完全是您想要的（您需要它来获取 PHP 源代码），但支持很好并且可以使用。反应性的，可能您的需求将包含在下一个版本中。

回复收藏 0 原文

沧桑㈠ 2024-09-13 02:28:24

我必须为我自己的 PHP IDE 实现 phpDoc 解析格式。我正在做的只是简单地逐个解析字符，帕斯卡代码与此类似：

len := length(fCode);
i:= 1;
inComment:= false;
while i < len do
begin
  case fCode[i] of
   '*': begin 
        if (fCode[i-1] = '/') and (fCode[i+1] = '*') then
        begin
          inComment:= true;
        end
        else if fCode[i+1] = '/' then
        begin
          inComment:= false;
        end;
   '@' : begin
            j:= i;
            while (fCode[i] in ['a'..'z','A'..'Z']) do
                inc(i);
            tagName:= copy(fCode, j, i - j +1);
            // do it again for type, name and the rest MIGHT be description! check for liebreak!
         end;
  end;
 inc(i);
end;

代码并不完美（应该更多地检查索引是否> 0和< len等），但应该给你这样的想法我在说什么。

该代码尚未经过测试，甚至也没有编译 - 写在 SO 的“你的答案”框中;);)

I had to implement phpDoc parsing format for my own PHP IDE. What I'm doing is simply parsing char by char, the pascal code similar to this:

len := length(fCode);
i:= 1;
inComment:= false;
while i < len do
begin
  case fCode[i] of
   '*': begin 
        if (fCode[i-1] = '/') and (fCode[i+1] = '*') then
        begin
          inComment:= true;
        end
        else if fCode[i+1] = '/' then
        begin
          inComment:= false;
        end;
   '@' : begin
            j:= i;
            while (fCode[i] in ['a'..'z','A'..'Z']) do
                inc(i);
            tagName:= copy(fCode, j, i - j +1);
            // do it again for type, name and the rest MIGHT be description! check for liebreak!
         end;
  end;
 inc(i);
end;

the code is not perfect (there should be more checking whether indexes are > 0 and < len, etc) but should give you the idea of what I'm talking about.

the code has not been tested, nor even compiled - written in the "your answer" box of SO ;) ;)

回复收藏 0 原文