Namespace documentation on a .Net project (Sandcastle)?

后端 未结 7 506
萌比男神i
萌比男神i 2020-12-23 09:12

I started using Sandcastle some time ago to generate a Documentation Website for one of our projects. It\'s working quite well but we\'ve always only written documentation f

相关标签:
7条回答
  • 2020-12-23 09:45

    Use Sandcastle Help File Builder. It allows to specify namespace descriptions in the XML project file

    Example:

    <namespaceSummaryItem name="System" isDocumented="True">
        Generic interfaces and helper classes.
    </namespaceSummaryItem>
    

    References:

    • example of Open Source project that generates documentation with every build (all scripts are in the trunk).
    • That's how the documentation by SHFB looks like on the Web (it is deployed on every forced build)

    .

    0 讨论(0)
提交回复
热议问题