sandcastle | 易学教程

Generate html documentation automatically during a build with Sandcastle

阅读更多关于 Generate html documentation automatically during a build with Sandcastle

问题 What steps do I need to take to get HTML documentation automatically building via the build step in Visual Studio? I have all the comments in place and the comments.xml file being generated, and Sandcastle installed. I just need to know what to add to the post-build step in order to generate the docs. 回答1: Some changes have been made since this question was asked. Sandcastle no longer includes SandcastleBuilderConsole.exe . Instead it uses plain old MSBuild.exe . To integrate this with visual

Code documentation for delphi similar to javadoc or c# xml doc

阅读更多关于 Code documentation for delphi similar to javadoc or c# xml doc

I need a code documentation tool similar to javadoc or c# xml doc for delphi code. What is the best tool? I prefer a technology, which is in the future compatible to the Microsoft sandcastle project. Arnaud Bouchez Take a look at SynProject , an Open Source tool written in Delphi. It was designed to handle a full documentation workflow, from specifications to release notes, including tests, architecture and design; and of course there is an integrated Delphi parser to generate architecture documentation from existing Delphi source code. For the architecture document, the source code can

Automatically Unit Test Example Code

阅读更多关于 Automatically Unit Test Example Code

问题 My team is responsible for the development of an API for a large system that we also write. We need to provide example code so that other developers using our API can learn how to use it. We have been documenting the code using the xml document comments. eg. /// <summary>Summary here</summary> /// <example>Here is an example <code>example code here</code> </example> public void SomeFunction() We then use Sandcastle and build the help files we need (chm and an online website). It is quite

How to localize the documentation of a .NET library [closed]

阅读更多关于 How to localize the documentation of a .NET library [closed]

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . I have an open-source project (here) whose documentation is currently in French. The documentation is generated from XML comments in code, using Sandcastle. Now I would like to translate the documentation to English and provide documentation in both languages, but I don't really know where to start... Do I need to

Code documentation for delphi similar to javadoc or c# xml doc

阅读更多关于 Code documentation for delphi similar to javadoc or c# xml doc

问题 I need a code documentation tool similar to javadoc or c# xml doc for delphi code. What is the best tool? I prefer a technology, which is in the future compatible to the Microsoft sandcastle project. 回答1: Take a look at SynProject, an Open Source tool written in Delphi. It was designed to handle a full documentation workflow, from specifications to release notes, including tests, architecture and design; and of course there is an integrated Delphi parser to generate architecture documentation