如何本地化 .NET 库的文档

问题描述

我有一个开源项目(这里)，其 文档 目前为法语.该文档是使用 Sandcastle 从代码中的 XML 注释生成的.现在我想将文档翻译成英文并提供两种语言的文档，但我真的不知道从哪里开始......

I have an open-source project (here) whose documentation is currently in French. The documentation is generated from XML comments in code, using Sandcastle. Now I would like to translate the documentation to English and provide documentation in both languages, but I don't really know where to start...

• 我是否需要从代码中提取 XML 注释并将它们放在单独的文件中?如果是，是否有任何工具可以自动化该过程?
• 我正在使用 Sandcastle Help File Builder 构建文档；我需要创建一个单独的项目来构建英文文档，还是可以从同一个项目中完成?
• 在翻译过程中是否有任何工具可以提供帮助?例如并排显示原始文档和翻译文档?

我也对如何制作多语言文档的链接感兴趣，因为我在 Google 上找不到任何有用的东西...

I'm also interested in links on how to produce multilingual documentation, as I couldn't find anything useful on Google...

推荐答案

一种需要与 Sandcastle XSLT 文件协调的策略是在 XML 上使用 xml:lang 属性文档.Visual Studio 2010 允许保留多个标签(尽管您可能会收到有关重复标签的投诉).

One strategy, which would require some coordination with the Sandcastle XSLT files, would be to use the xml:lang attribute on your XML documentation. Visual Studio 2010 allows multiple tags to remain (although you may get complaints about duplicate tags).

/// <summary>
/// Gets or sets the fill size of the load operation.
/// </summary>
/// <summary xml:lang="fr">
/// Obtient ou définit la taille de remplissage de l'opération de chargement.
/// </summary>
public int FillSize
{
    get;
    set;
}

结果输出:

<member name="P:Namespace.MyAttribute.FillSize">
    <summary>
    Gets or sets the fill size of the load operation.
    </summary>
    <summary xml:lang="fr">
    Obtient ou définit la taille de remplissage de l'opération de chargement.
    </summary>
</member>

这篇关于如何本地化 .NET 库的文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持html5模板网！