documentation-generation

2热度

3回答

我正在使用Sphinx来记录项目。它从restructured text生成LaTeX文件。我想设置背景色为灰色的提示和笔记，所以我创造一个灰盒环境后定制通知环境： \definecolor{MyGray}{rgb}{0.80,0.80,0.80} \makeatletter\newenvironment{graybox}{% \begin{lrbox}{\@tempboxa}\b

15热度

6回答

C＃编程的XML注释提示

早上好，下午，傍晚或晚上（取决于您的时区）。这仅仅是关于C＃中的XML注释一个一般性的问题。我从来没有对评论我的程序过大，我一直是一个详细的变量/属性/方法的名字，让代码自己说话。如果我编写了一些相当混乱的东西，我会写评论，但大多数情况下我不会写很多评论。我正在做一些关于.NET，Sandcastle和codeplex上的帮助文件构建器的XML注释的阅读，并且它让我想要记录我的代码并为那些拥有

0热度

3回答

需要一种很好的方式在网络上共享iPhone源代码

我正在寻找一种方法来与我人分享一些iPhone SDK源代码。目标：共享iPhone SDK源代码，Objective C用XCode编写。我有一个很好的我想分享的源代码。我想让它变得简单。我希望它有语法突出显示，通过这个我的意思是着色和格式化理想情况下，它会让我有一些空间，使其“适合”我的网站。我希望它看起来像我的网站上的另一个页面，其中的内容是代码。换句话说，它不应该只是一个文本文件

6热度

7回答

关于开源项目文档的建议？

我们正在考虑记录一个刚刚起步的open source project，我希望能提供一些关于良好方法和工具的建议，这些方法对您而言非常合适。此外，作为开发人员，您是否喜欢在线文档，基于wiki的文档，帮助文件或其他？

2热度

5回答

用于记录C结构的程序？

如果你有一个被描述为C结构的二进制文件格式（或数据包格式），是否有任何程序可以解析结构并将其转换为你的协议的整洁文档？该结构当然会包含数组，其他结构等，以描述格式。该文件很可能需要包括像包装，字节序等

6热度

3回答

如何在.NET中使用内联注释文档成员？

如何在.Net中内嵌文档成员？让我解释。大多数从注释中提取文档的工具都支持某种内联文档，您可以在成员声明后添加摘要。就像： public static string MyField; /// <summary>Information about MyField.</summary> 有没有办法在C＃或.NET语言中做到这一点？

4热度

6回答

作者在维基，生成PDF文档，CHM文件或嵌入帮助

任何人都知道一个wiki或wiki插件可以生成一个PDF文件或跨越整个维基的CHM文件？我想控制目录。我想内部和外部链接工作。理想情况下允许调整输出模板，但这不是一个交易断路器。我想使用WIKI语法和心态（大量交叉链接等）生成内容，但以PDF，CHM或嵌入式应用程序的形式发送内容。比在终端用户机器上安装wiki软件更友好...