Fatal编程技术网
  • csharp/
  • C# 在单独的文件中包含Sandcastles的代码示例

C# 在单独的文件中包含Sandcastles的代码示例

c# .net

C# 在单独的文件中包含Sandcastles的代码示例,c#,.net,chm,sandcastle,C#,.net,Chm,Sandcastle,我试图在使用Sandcastles生成的CHM文件中包含代码示例。以下是我到目前为止的情况： /// <summary> /// Lorem ipsum. /// </summary> /// <example> /// <code> /// public int Test /// { /// private int test { get; set } /// private int test2 { get; set; } /// public i

我试图在使用Sandcastles生成的CHM文件中包含代码示例。以下是我到目前为止的情况：

/// <summary>
/// Lorem ipsum.
/// </summary>
/// <example>
/// <code>
/// public int Test
/// {
/// private int test { get; set }
/// private int test2 { get; set; }
/// public int findE()
/// {
/// if(test == test2){
/// return Console.WriteLine("Variables are Equal")
/// }
/// else{
/// return Console.WriteLine("Variables are not equal")
/// }
/// }
/// }
/// </code>
/// </example>
这是非常混乱的，我不希望在我的.cs文件中有这段代码。是否有办法将此示例代码放在一个单独的.cs文件中，并以某种方式在注释中引用它？所以我会有这样的东西：

/// <summary>
/// Lorem ipsum.
/// </summary>
/// <reference src="mycode.cs">
/// </example>

//
///同侧眼线。
/// 
/// 
///
当然可以。假设您创建了一个外部代码文件Example.cs。在该文件中，您将放置示例，周围是一个命名的
区域

#region example1
Console.WriteLine("Hello, World!");
#endregion
在为其创建示例的元素的XML注释中，指定外部代码示例的源代码：

/// <summary>blah blah my class</summary>
/// <example><code source="Example.cs" region="example1" lang="C#" 
/// title="Some Title to Display" /></example>
public class Hurr
{
 // ...

///诸如此类
///
公开课
{
// ...
C#不需要指定语言，因为这是默认语言，如果不指定区域，它将包括示例文件中的所有代码

还请注意，源文件路径是相对于SHFB项目文件的，不一定是Visual Studio项目文件。如果配置代码块组件（在SHFB->project Properties->Components中），则可以指定其他基本路径