【问题标题】:Visual Studio: auto documentation for generated codeVisual Studio:生成代码的自动文档
【发布时间】:2017-10-24 14:36:36
【问题描述】:

如何为自动生成的代码生成带有文档 (doxygen) 的模板?

更准确地说:我在我的 C# 应用程序中使用了几个连接的服务。 因此,Visual Studio 会生成一些文件,包括带有 WCF 服务方法的包装类的“Reference.cs”。

现在我正在为我的整个项目生成 doxygen 文档并获得空白的命名空间和类文档。

例如

//------------------------------------------------------------------------------
// <auto-generated>
//     Dieser Code wurde von einem Tool generiert.
//     Laufzeitversion:4.0.30319.42000
//
//     Änderungen an dieser Datei können falsches Verhalten verursachen und gehen verloren, wenn
//     der Code erneut generiert wird.
// </auto-generated>
//------------------------------------------------------------------------------

/// COMMENT NEEDED
namespace MyApp.ActionService {
[...]   

/// COMMENT NEEDED
public interface IActionsService {

[...]

/// COMMENT NEEDED
public partial class ActionsServiceClient : [...]

我需要的是一个通用的 doxygen 注释,例如我的代码 sn-p 的每个 COMMENT NEEDED 部分中的“自动生成的类”。注意:我添加 COMMENT NEEDED cmets 只是为了说明我的问题。它们不是生成器输出的一部分。

是否可以为代码生成器编辑模板?

【问题讨论】:

  • 你不能从正在生成的文档中排除生成的类吗?这样在模板中添加无用的 cmets 会更容易。
  • 我想过。但是文档是交付给我的客户的一部分。所以他可能会认为缺少几个类的文档,因为他不知道代码是自动生成的。
  • 为什么不首先用您的生成器将 "COMMENT NEEDED" 替换为 "autogenerated class"
  • // COMMENT NEEDED 不是生成器输出的一部分。我将它们手动添加到 SO 示例中以说明我需要哪些 cmets。在生成的代码中没有这样的注释(不太可能)
  • 你可以制作一个可以在 30 分钟内完成的程序

标签: c# visual-studio wcf


【解决方案1】:

看起来 VS 不像在其他自动生成场景中那样使用可编辑的 T4 模板来生成代理类。您可以为此使用针对 svutil 构建的工具。

Custom WSDL Publication

Make svcutil pick up documentation from C# files?

【讨论】:

    猜你喜欢
    • 2012-05-23
    • 1970-01-01
    • 2014-12-19
    • 2017-04-20
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2012-09-21
    • 2011-02-13
    相关资源
    最近更新 更多