使用SandCastle创建.Net帮助文档

第一步，为你写的代码添加XML注释

usingSystem;

usingSystem.Collections.Generic;

usingSystem.Text;

namespaceClassLibrary1

{

///<summary>

///AsampleclasstoshowsomethingusingSandcastle

///</summary>

publicclassSampleClass

{

privatestring_propertyValue;

///<summary>

///Getsorsetsthepropertyvalue.

///</summary>

///<value>Thepropertyvalue.</value>

publicstringProperty

{

get

{

return_propertyValue;

}

set

{

_propertyValue=value;

}

}

///<summary>

///Determineswhetherthepropertyisnull.

///</summary>

///<returns>

///<c>true</c>ifpropertyisnull;otherwise,<c>false</c>.

///</returns>

publicboolIsPropertyNull()

{

boolresult=false;

if(this.Property==null)

{

result=true;

}

returnresult;

}

///<summary>

///Determineswhetherthepropertyisnull.

///</summary>

///<returns>

///<c>true</c>ifpropertyisempty;otherwise,<c>false</c>.

///</returns>

///<example>

///Thisexampleshowshowyoumightusethismethod:

///

///<code>

///SampleClasssample=newSampleClass();

///

///if(sample.IsPropertyEmpty())

///{

///Console.WriteLine("Thepropertyisempty");

///}

///else

///{

///Console.WriteLine("Thepropertycontainsvalue"+sample.Property);

///}

///</code>

///</example>

publicboolIsPropertyEmpty()

{

boolresult=this.IsPropertyNull();

if(!result)

{

result=(Property.Trim().Length==0);

}

returnresult;

}

}

}