我用适当的ms xml文档标签评论了所有代码.如何为所有注释代码生成仅HTML(或pdf)文档？我已经下载了sandcastle,但无法弄清楚如何进入下一步.谢谢!
我已阅读如何为CHM或HTML文件生成C#文档？.但是,我使用visual studio 2012,这个问题的所有答案都在Visual Studio 2010及更低版本中.那么,我如何在visual studio 2012中生成它？
我的项目不是使用 autodoc 构建的。我遇到了有关我的项目未在 autodoc 中构建的常见问题。但是，某些依赖项包含不会在构建文档服务器上执行的 C 代码。因此，我阅读了此博客中的方法，解释我应该使用模拟。这与 stackoverflow 问题“how-to-mock-so-that-from-x-import-works”相关。
在阅读文档的管理页面的高级设置部分中，有一个使用 virtualenv 的选项，我检查了该选项，然后请求了我的项目根目录到requirements.txt的路径。
项目目录结构如下：
GatherNews/
requirements.txt
当我用作GatherNews/requirements.txt路径时。我收到错误：
/var/build/user_builds/gathernews/checkouts/latest/docs/api/grss.rst:10：警告：autodoc：无法从模块 u'gathernews.gRSS' 导入类 u'CaptureFeeds'；提出了以下例外情况：
回溯（最近一次调用最后一次）：
文件“/home/docs/checkouts/readthedocs.org/user_builds/gathernews/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py”，第 335 行，在 import_object import (self .modname)
文件“/home/docs/checkouts/readthedocs.org/user_builds/gathernews/envs/latest/local/lib/python2.7/site-packages/gathernews/ init .py”，第 1 行，导入 gRSS
文件“/home/docs/checkouts/readthedocs.org/user_builds/gathernews/envs/latest/local/lib/python2.7/site-packages/gathernews/gRSS.py”，第 38 行，导入 feedparser
ImportError：没有名为 feedparser /var/build/user_builds/gathernews/checkouts/latest/docs/_themes/README.rst:: 警告：文档不包含在任何目录树中
我的问题是如何将这一切联系在一起？具体来说，我是否使用正确的路径来requirements.txt阅读文档以成功构建？如果我的路径requirements.txt正确，那么如何包含模拟包以成功生成自动文档？
我有一个HTML(例子)中的常见问题解答,其中的问题相互引用很多.这意味着无论何时插入/删除/重新排列问题,编号都会发生变化.LaTeX使用\ label和\ ref非常优雅地解决了这个问题 - 你给项目简单的标签和LaTeX担心在最终文档中转换为数字.
人们如何处理HTML中的问题？
增加:请注意,如果您不必按编号实际引用项目,则不会有问题,在这种情况下,您可以设置标记
<a name="foo">
然后链接到它
<a href="#foo">some non-numerical way to refer to foo</a>.
但我假设"foo"有一些自动生成的数字,比如从<ol>列表中说出来,我想用这个数字来引用并链接到它.
我正在研究我的公司如何处理文档（尤其是编程文档）。我希望能够同步不同Word文档的各个部分，以便如果一个文档中的某个部分发生更改，那么更改将反映在另一文档中，反之亦然。有没有办法用Word做到这一点，如果没有，是否有一些擅长此事的文字处理程序？
当我运行时sbt doc,它会产生一个很好但非常基本的文档.是否有可能
a)包括类定义的源文件和
b)继承继承成员的文档字符串？
我需要将哪些内容添加到项目定义中？
(这是一个Lift项目,所以最重要的是将继承的Lift文档字符串存在.)
我很好奇Doxygen是否解析了Javadoc的评论？ - 也就是说,doxygen接受类似的东西:
/**
Greet with a "Hello" message.
@param a string containing the name of the person or entity
@ret return a string containing "Hello" and the name of the greeted person or entity.
*/
public String sayHello(string name)
{
return "Hello" + name;
}
还有一件事,是否有更正确的方式来做这些评论,doxygen风格？
我无法生成项目的文档.获取NetBeans"'"php.exe"'下的错误消息不会被识别为内部或外部命令,可运行程序或批处理文件." ApiGen 2.8.0独立版已在单独的文件夹中解压缩,其参考文献在Tools-> Options-> apigen下给出.任何人的建议？请提前.