axaptapedia: Sandcastle

[Blog bot]

Источник: http://www.axaptapedia.com/Sandcastle
==============

Summary: /* Modifying the generated reflection file (reflection.org) */

<div>== Introduction ==

[http://sandcastle.codeplex.com Sandcastle] documentation compilers enable managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel. With Dynamics AX, one can create [http://msdn.microsoft.com/en-us/library/cc593549.aspx XML documentation files] that can be compiled with [http://sandcastle.codeplex.com Sandcastle] to create [http://en.wikipedia.org/wiki/Microso...iled_HTML_Help CHM help] files.


An [[media:ShellExecute.chm.zip|example]] of Dynamics AX XML documentation compiled with Sandcastle:

[[Image:ShellExecute.png]]

== Required Software ==

Microsoft .NET Framework Version 2.0, available [http://msdn.microsoft.com/netframewo...s/default.aspx here]

HTML Help Workshop available [http://msdn.microsoft.com/library/de...pDownloads.asp here]

Sandcastle available [http://sandcastle.codeplex.com/Relea...tReleases.aspx here] or [http://www.microsoft.com/downloads/d...5-696e3a4873b2 here]

== Steps ==

# Creating the XML documentation files
# Modifying the generated reflection file (reflection.org)
# Optional additions
# Compiling Sandcastle

=== Creating the XML documentation files ===

Follow the steps described in the [http://msdn.microsoft.com/en-us/library/cc654944.aspx Dynamics AX 2009 SDK] to generate the XML documentation files. Be sure to store both the documentation and reflection file in the same folder and name them as follows:

comments.xml (documentation file)

reflection.org (reflection file)

=== Modifying the generated reflection file (reflection.org) ===

In order for Sandcastle to create the table of contents and generate the html files, the following changes need to be made to the reflection file:


Replace the first occurance of ''