. NET extract Comment generation API documentation Help documentation

First, preface

In a multi-person collaborative project, in addition to good code specifications, the complete API documentation is also very important. Through the documentation we quickly understand the actual interface of each module of the system, its usage scenarios, use examples to reduce communication costs to a certain extent, and reduce the risk of loss of knowledge in later maintenance.

For. Net, we can directly convert the annotations of classes, methods, etc. directly to the API documentation, greatly reducing the workload of document maintenance, while also reversing the quality of everyone's comments.

Below we use. NET unique annotation generation API documentation Tool--sandcastle and Sandcastle Help file Builder to automate the API documentation!

Second, the tool

sandcastle:http://sandcastle.codeplex.com/

Sandcastle Help File builder:http://shfb.codeplex.com/

Iii. from annotations to API documentation

1. Generating an XML document file

Step: 1. In VS, right-click the assembly, select Properties, select the Build page, tick the "XML document File"

2. After compiling the assembly, you can find the assembly name under the build directory. XML "file.

2. Using SandcastleBuilderGUI.exe to generate API documentation

After installing the tools Sandcastle and Sandcastle help File Builder, click SandcastleBuilderGUI.exe to access the Document Generation project interface.

Step: 1. Configure Document Basics: Click the "Help File" page

Follow, configure document title, document name, document language, document style.

2. Load the assembly DLLs and XML files into the document build project.

Right-click Documentation Sources, select Add documentation Sources, and then add the assembly DLL and XML in.

3. Generate API Documentation

Click "Build Project", "Documentation" on the menu bar, and you can find the API documentation just in the same directory as the Sandcastle help File Builder.exe.

Iv. Summary

Only some of the features of Sandcastle help File Builder are described above and will be replenished later.

Respect the original, reprint please indicate from: http://www.cnblogs.com/fsjohnhuang/p/3968313.html ^_^ Fat Boy John

V. References

http://guojun2sq.blog.163.com/blog/static/643308612010116394430/

http://www.boyd.cn/info_Show.asp?ArticleID=4945

http://blog.csdn.net/chtnj/article/details/8278342

http://blog.csdn.net/chtnj/article/details/8278360

. NET extract Comment generation API documentation Help documentation