使用TypeLite生成文档

时间:2015-10-07 18:07:23

标签: visual-studio typescript typelite

是否可以将TypeLite配置为将文档从源复制到目标类,以便Visual Studio中提供工具提示文档?

这是一个基本示例(按TypeLite quickstart中所述进行配置):

public class Poco
{
    /// <summary>
    /// Documentation.
    /// </summary>
    /// <remarks>
    /// Remarks.
    /// </remarks>
    public string Name { get; set; }
}

生成以下内容:

interface Poco {
    Name: string;
}

但我想:

interface Poco {
    /**
     * Documentation.
     * 
     * Remarks.
     */
    Name: string;
}

1 个答案:

答案 0 :(得分:1)

TypeLite支持从C#类中的Xml注释生成JDoc注释。您需要调用WithJSDoc()流畅的配置方法。

<#
    var ts = TypeScript.Definitions()
        .WithReference("Enums.ts")
        .WithJSDoc();
#>

它需要带有文档的XML文件与二进制文件一起生成。

project configuration

.NET便携式项目不支持此功能。