Use docproject to generate. Net object files (1)

A complete and comprehensive object file is of great importance in terms of technical use, technical use, and usage (it is not suitable for personal use ), think about a new employee or a person who takes over your job. There is no file but to look at the original hacker or just unguess it. This is a painful thing, however, copying an object file was previously very troublesome, and there was no similar tool at all. For example, I used word to prepare the object file as early as possible, class Name, funciotn, and property are all written on zookeeper, followed by instructions, which are both powerful at runtime and have no synchronization function, when the keyword is modified, only the word can be modified. In order to improve the problem, we have found many samples, such as ndoc, which are much easier to use than word, however, it is still inconvenient to use, and it cannot be self-contained (maybe I will not use it ), however, it is not difficult to make an object file in a docproject ).

Docproject is an example on codeplex, and codeplex is an example. net, I find the docproject from Visual Studio addins. The use of docproject is very simple, and the content specification and settings are both hierarchical, it is very convenient to use. The generated files are as beautiful and convenient as the msdn library. They also have the index and query functions, which are actually too easy to use, I have read a storyArticleThat's why sandcastle's tools make their company have to spend a few days preparing documents. Now it's very easy. This is not a problem, if, at the time of object creation, the XML file is often used for resolving the issue, a complete and complete object file is generated, docproject is the Gain set of Visual Studio 2005/2008. It is used in case-sensitive mode. It is also applicable to the internal window version for Express users who cannot use the Gain set, currently, only C # and VB are supported.. net, C ++/CLI can only be generated using the upper window (not yet ).

Docproject official website has rich descriptions

The following documents are required for the security protection docproject (officially stated)
Visual Studio 2005 with Service Pack 1
Sandcastle, June 2007 CTP
HTML Help Workshop: Help 1.x
Visual Studio 2005 SDK: Help 2.x (optional)

Install the above software in the security protection docproject

Use Case samples to create case and file cases

First, create a new case (the docproject also supports the website. Here, the case is used as an example, and the official statement of the program case is acceptable, however, I did not succeed.) in this case, we usually use the same method to create some differences and add some XML file decoding (such as Example 1 ).

Parse an XML file

 
Change and build options, add the XML file layout (for example, step 2) (Be sure to check and the XML partition name cannot be changed, otherwise I will renew it later ), then build the deployment case (you must first build the case, and then build the case after modification, otherwise you will find the last build ).

Second, build and select

 

Then join the new project and select the docproject transcript (for example, Release 3)

Example 3: Add docproject proposal

 

Make sure there are excellent candidates for us to select some options. The first option has two options: sandcastle and Sandcastle/deployment (such as release 4 ), only sandcastle can be selected for a single case. sandcastle/deployment can be selected for a single case, and a website can be created for others to upload.

Option 4: Building Type Selection

 

The next option is the external choice (for example, the fifth choice ),

Category 5 foreign currency

 

Again, it is the optimized type (such as Objective 6), because I do not have Visual Studio 2005 SDK: help 2. x, so I cannot select compiled help 2.x( I think help 2. X sharing is more difficult ).

Type derived from limit 6

 

In addition, most shared content does not need to be changed. The only thing to change is the header (such as limit 7, the start of each shard uses internal settings (for example, release 8)

Shared content

 

Forgot to change the header.

 

Another example is the case (for example, Case 9) to be selected. If you forget the case, you can add the case to be selected in the examination of the file case.

29th

In this way, the file writing case is added. If there is no need to compile the case, the file presentation file can be created.

 

Upload volume File Content

After the docproject security is completed, a new work column (such as limit 10) will be added, with two presses and one isAPI topic desinger, The other isAPI topic management,Only file cases that must be used can be used..

December 10

 

API topic desingerIs a memory generator that shares content (for example, memory 7 ),API topic managementIs the internal memory of an object. You can choose between these two functions from tools> Options>Docproject>Active projectsMedium call

API topic management

The topic filter can select the categories to be selected (such as the 11th day). There are many options for the selection, depending on your situation.

2017-12-11

 

XML comments is an XML file solution for a comment object. The easy-to-use comment generator can insert content into the content, insert a comment, and typeset, each API has three XML files (optional values: sumary, ramarts, and example). If you have read msdn, you cannot guess the output address, however, only three XML files are provided for selection, but other XML files on the original file will also be released, such as PARAM and exception (such as Example 1 ).

UseAPI topic managementParse the XML file of zookeeper and does not modify the parse of the original metadata (I want to override the parse of the original metadata ), instead, the statement is in the file proposal case> comments> [Statement name statement]. XML: When the parameter is set, the XML file of the original statement is overwritten when the parameter is set, parse and export data using the XML file of the example.

 

(Pending pending ....)