微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX，目前支持C＃和VB，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网...
分类：
其他好文 时间：
2015-12-30 07:03:22
阅读次数：
443
VVDocumenter-Xcode是Xcode上一款快速添加标准注释，并可以自动生成文档的插件。有了VVDocumenter-Xcode，规范化的注释，只需要输入三个斜线“///”就可以搞定，非常方面实用，目前已经支持Swift。Objective-C效果图：Swift效果图：从Xcode 5开始...
分类：
其他好文 时间：
2015-12-21 00:11:13
阅读次数：
155
在docfx中，最重要的就是生成文档，把markdown文件（gfm语法）转换成html。 为了这一步，我们找了N个.net开源项目，发现要么是common markdown的，要么不容易扩展，没有一个是基于gfm的并且很容易扩展的语法的markdown开源项目。无奈之下，再找.net下执行j...
分类：
其他好文 时间：
2015-12-18 21:25:17
阅读次数：
330
使用eclipse生成文档（javadoc）主要有三种方法： 1，在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。 在Javadoc Generation对话框中有两个地方要注意的： javadoc command:应该选...
分类：
编程语言 时间：
2015-12-14 19:00:16
阅读次数：
181
VVDocumenter-Xcode是Xcode上一款快速添加标准注释，并可以自动生成文档的插件。有了VVDocumenter-Xcode，规范化的注释，只需要输入三个斜线“///”就可以搞定，非常方面实用，目前已经支持Swift。Objective-C效果图：Swift效果图：从Xcode 5开始...
分类：
其他好文 时间：
2015-12-10 13:05:37
阅读次数：
142
文档字符串可以在运行时访问，也可以用来自动生成文档。输入：def foo(): print "This is a doc string" return Truefoo()运行结果：This is a doc string
分类：
编程语言 时间：
2015-11-23 18:28:54
阅读次数：
144
注释文档：
Java带给我最大的惊喜还是它的注释文档，注释文档的出现将代码和文档链接起来，为我们免去了编写修改文档的麻烦，而且生成的HTML文档格式也是美cry的。
javadoc：
javadoc就是用于提取注释生成文档的工具，它是JDK的一部分。Javadoc不仅整合注释里的信息，还把相邻的类名或者方法名提取出来，让我们用最小的力气生成好看的文档。
生成方式：
1. 命令行：
javadoc -d 文档存放目录 -author -version 源文件名.java...
分类：
其他好文 时间：
2015-11-15 06:21:30
阅读次数：
337
奋战了几个月，docfx终于有些像样了。预览文档： http://aspnet.github.io/docfx/源代码正在准备开源中Nuget包很快会发布FAQ:Q: docfx是什么？A: docfx是一个api文档编译软件，它能根据c#/vb源代码生成对应的文档元数据并生成文档（目前提供html...
分类：
其他好文 时间：
2015-11-10 00:04:41
阅读次数：
235
转自：http://edi.wang/post/2013/10/28/auto-generate-help-document-aspnet-webapi我选择Web API的一个重要原因就是因为可以自动生成文档，省去了开发人猿不少宝贵的时间。以前在用Web API第一代的时候，自动生成帮助文档的功能...
VVDocumenter-Xcode上一款快速添加标准注释，并可以自动生成文档的插件。有了VVDocumenter-XcodeObjective-C效果图：Swift效果图：从UUID证书从而保证插件的稳定性。因此Xcode的Info.plist文件中添加UUID。步骤如下：一、查看UUID方式1在...
分类：
其他好文 时间：
2015-10-27 06:56:19
阅读次数：
248
