PROSAGA码农传奇-智能感知系统-.NET项目的独立文档

<div class =“post-text”itemprop =“text”>
  
    从广义上讲，这正是我目前所做的，而且我正在使用Doxygen。
  
  
    但是，我担心我对.NET一无所知。我正在开发的项目是一个Java包，但包括从源代码，用户指南，发布记录和弃用等内容中提取的API文档。
  
  
    唯一超出我们范围和你的范围的是安装指南，但这只是因为开发人员只在安装后才能阅读它。
  
  
    我们让Jenkins CI在每次更改时都会构建文档。
  
  
    “描述性”文本全部用Markdown编写，Doxygen处理得相当好。
  
  
    的
      缺点
    </强>
    ：如果您熟悉Doxygen处理源代码文本分组的方式，您可能会感到困惑的是这些命令不能用于对Markdown中的文本块进行分组。还有一些其他特殊的奇怪之处，但如果你扫描我自己关于这个主题的问题，你可能会找到大部分奇怪的东西（
    <a href="https://stackoverflow.com/questions/19835890/doxygen-how-to-make-an-entire-file-internal">
      这里
    </A>
    ，
    <a href="https://stackoverflow.com/questions/19998255/does-doxygen-file-work-in-markdown-files">
      这里
    </A>
     和
    <a href="https://stackoverflow.com/questions/19704822/how-to-use-markdown-pages-and-doxygen-groups">
      这里
    </A>
    ）
  
  
    的
      上升空间
    </强>
    :(我们发现你没有提到的有用的东西）
  
  <OL>
    <LI>
      
        我们还可以解析Java API中的'doxygen'标记，以创建IDE（例如Eclipse）可以使用的javadoc。这意味着我们必须将自己限制在API文档中的javadoc样式命令，但这不是一个很大的限制。
      
    </LI>
    <LI>
      
        我们在doxygen'构建开关'下包含了一本手册
        
          您的
        
         开发人员如何编写手册的文档（好的，这有点递归！）。这提供了使用的推荐命令子集，以及是否（根据品味）您希望人们使用doxygen
         <code>
 @subsection
 </code>
         或Markdown
         <code>
 ##
 </code>
         标题等
      
    </LI>
  </醇>
  
    希望有所帮助。
  
  
    我建议你尝试一下;试验你需要的每种类型的文档部分的样本，看它是否会完成你需要的整套功能。没有什么比这更烦人的记录90％然后发现它不会做最后10％。
  
</DIV>

.NET项目的独立文档 - doxygen？