uex keygen_UEX =用户培训和生成

uex keygen

I was poking around in the Authorization and Profile Application Block and noticed what nice documentation it has.  I'm a HUGE fan of NDoc, and we build a great deal of documentation with it during the automated build process. (The goal: NAnt -> NUnit -> NCover -> NDoc)

我在“授权和配置文件应用程序块”中闲逛，发现它有什么不错的文档。 我是NDoc的忠实拥护者，在自动化的构建过程中，我们用它建立了许多文档。 (目标：NAnt-> NUnit-> NCover-> NDoc)

Lots of folks know the basics about XML Documentation in C# but usually only take it this far:

很多人都了解C＃中XML文档的基础知识，但通常只走得这么远：

   /// <summary>    /// The entry point for the application.    /// </summary>    /// <param name="args"> A list of command line arguments</param>    public static int Main(String[] args)    {        return 0;    }

 /// <summary> ///应用程序的入口点。 /// </ summary> /// <param name =“ args”>命令行参数列表</ param> public static int Main(String [] args){return 0; }

However there's a lot more cool stuff/tags beyond summary and param that can be done with XML Documentation.  Also adding LOTS of rich documentation to your source code can make the files unruly and end up containing more prose then code. 

但是，除了XML文档可以使用的摘要和参数外，还有很多其他很酷的东西/标签。 同样，在源代码中添加大量丰富的文档可能会使文件不规则，并最终包含比代码更多的散文。

So, you can instead add your documentaiton like this:

因此，您可以这样添加文档：

   /// <include file="doc\Main.uex" path='docs/doc[@for="MyNamespace.Main"]/*'></include>    public static int Main(String[] args)    {        return 0;    }

/// <include file =“ doc \ Main.uex” path ='docs / doc [@ for =“ MyNamespace.Main”] / *'> </ include> public static int Main(String [] args){返回0; }

and then you'd have a file called Main.uex in your doc directory:

然后在doc目录中有一个名为Main.uex的文件：

<docs> <doc for="MyNamespace.Main">        <summary>            <para>Get the whatever from the <paramref name="whateverElse"/> for the <paramref name="whatever"/>.</para>        </summary>        <param name="whateverElse">            <para>The section to retrieve the whatever.</para>        </param>        <param name="whatever">            <para>The whatever to retrieve.</para>        </param>        <returns>            <para>The <see cref="SomeClassName"/> for the given name.</para>        </returns>        <exception cref="SomeException">            <para>An error occurred while performing the operation.</para>        </exception>        <remarks>
            <para>Here is some text about something.</para>            Here is the config section in the configuration file:            <code>
            ...
            &lt;section name="mySection" type="MyConfigHandler,MyAssembly,Version=1.0.0.0,Culture=neutral,PublicKeyToken=null" /&gt;
            ...            </code>            Here is the code that do something.            <code>                 using System;
                class MyNamespace {                private String whatever;
                }
            </code>        </remarks>    </doc>
</docs>

<docs> <doc for =“ MyNamespace.Main”> <摘要> <para>从<paramref name =“ whateverElse” />中获取<paramref name =“ whatever” />中的所有内容。</ para> </ summary> <param name =“ whateverElse”> <para>用于检索所有内容的部分。</ para> </ param> <param name =“ whatever”> <para>要检索的内容。</ para> </ param> <返回> <para>给定名称<see cref =“ SomeClassName”/>。</para> </ returns> <exception cref =“ SomeException”> <para>执行该操作时发生错误。</ para> </ exception> <备注> <para>以下是有关某些内容的文字。 </ para> 这是配置文件中的config部分： <code> ... ＆lt; section name =“ mySection” type =“ MyConfigHandler，MyAssembly，Version = 1.0.0.0，Culture = neutral，PublicKeyToken = null” /＆gt; ... </ code> 这是执行某些操作的代码。 <code> 使用系统； 类MyNamespace { 私有字符串} </ code> </ remarks> </ doc> </ docs>

Another interesting thing is the <devdoc> tag, which is apparently to indicate documentation that originates from the developer and not the documentation team.   

另一个有趣的事情是<devdoc>标记，该标记显然是指示来自开发人员而不是文档团队的文档。

I think I'll be a lot more likely to include rich documentation for Frameworks we design if I have more room to add code samples and remarks.  Very cool.  You can find lots of great example of this kind of file in the newer Application Blocks, or the Rotor Source Code.  I recommend the former. 

我想，如果我有更多的空间来添加代码示例和注释，我将很有可能包含我们设计的框架的丰富文档。 很酷。 您可以在较新的应用程序块或“转子源代码”中找到许多此类文件的绝佳示例。 我推荐前者。

翻译自: https://www.hanselman.com/blog/uex-user-education-and-generating-ltdevdocgt

uex keygen