9

ServiceStack使用 c# 属性标记 Web 服务的休息路径。

例如

[RestService("/hello1")]
[RestService("/hello2")]
public class Hello

我想让 Doxygen 在 Hello 类的 doxygen 输出中包含 RestService 属性的值。如果输出文档中包含带括号的整行，我不太关心漂亮的格式。

有什么建议么？

一个快速而肮脏的技巧比编写 Doxygen 扩展更可取；）

干杯

泰梅克

====编辑

doxygen用户答案的​​ Python 版本（因此可以在 Windows 上轻松运行）将是：

#!/usr/bin/env python
import sys
import re

if (len(sys.argv) < 2):
    print "No input file"
else:
    f = open(sys.argv[1])
    line = f.readline()
    while line:
        re1 = re.compile("\[RestService\(\"(.*)\",.*\"(.*)\"\)]")
        re1.search(line)
        sys.stdout.write(re1.sub(r"/** \\b RestService: \2 \1\\n */\n", line))
        #sys.stdout.write(line)
        line = f.readline()
    f.close()

DOXYFILE 将具有：

INPUT_FILTER           = "doxygenFilter.py"
4

2 回答 2

10

您可以制作一个输入过滤器，将一行转换为

[RestService("/hello1")]

到

/** \b RestService: "/hello1"\n */

例如，将以下 perl 魔法放在一个名为的文件中filter.pl：

open(F, "<", $ARGV[0]);
while(<F>) { /^\s*\[RestService\((.*)\)\]\s*$/ ? 
             print "/** \\b RestService: $1\\n */\n" : print $_; }

并将其与INPUT_FILTERDoxyfile 中的标签一起使用：

INPUT_FILTER           = "perl filter.pl"
于 2012-02-15T21:11:26.453 回答
0

与其使用 python 或 perl 脚本，不如用 C# 来做对我来说更有意义

作为额外的奖励，属性的内联xml 文档也将添加到文档中。例子：

[FromForm(Name = "e_mail")]
[Required] /// <div>Specifies that a data field value is required.</div><p>More info...</p>

将 C# 控制台项目命名为“AttributesDocumenter”，并将生成的二进制文件与 Doxyfile 中的 INPUT_FILTER 标记一起使用： INPUT_FILTER = "AttributesDocumenter.exe"

using System;
using System.IO;
using System.Text.RegularExpressions;
using System.Threading.Tasks;

namespace AttributesDocumenter
{
    class Program
    {
        static async Task Main(string[] args)
        {
            if (args.Length < 1)
            {
                await Console.Out.WriteLineAsync("No input file");
                return;
            }

            var f = File.OpenText(args[0]);
            while (!f.EndOfStream)
            {
                var line = await f.ReadLineAsync();
                var match = Regex.Match(line, @"\s*\[(.*)]\s*");

                if (match.Success)
                {
                    var inlineXmlComment = Regex.Match(line, @".*\/\/\/");
                    if (inlineXmlComment.Success)
                    {
                        var inlineXmlCommentList = new Regex(@"\s*(</?([^>/]*)/?>).*").Matches(line);
                        var inlineXmlCommentCombined = string.Join("", inlineXmlCommentList);
                        await Console.Out.WriteLineAsync($"{inlineXmlComment.Value} <para><b>Attribute:</b> {match.Value}</para> {inlineXmlCommentCombined}");
                    }
                    else
                    {
                        await Console.Out.WriteLineAsync($"{line} /// <para><b>Attribute:</b> {match.Value}</para>");
                    }
                }
                else
                {
                    await Console.Out.WriteLineAsync(line);
                }
            }
        }
    }
}
于 2020-11-13T15:47:04.053 回答