新特性 smartDoc 0.1.1版正式发布,其中加入了更多方便生成文档的功能,主要特性如下: * 加入@demo配置项,看可以动态抓取html和js的内容作为@example,同时支持扩展@demo读取 * 支持jasmine测试js文件的单元代码抓取为@example * 实现多个example显示和tab切换 * 加入@show配置项来控制直接显示example效果 * 主题改版 * 去除@attribute属性设置,统一使用@property: docConfig新增配置: //dem…

曾几何时,当你码神附体,一路披荆斩棘的完成代码后,带着“一码在手,天下我有”的傲然环顾之时,却发现单元测试.API文档.Demo实例陆续向你砸来,顿时有木有一种冰水挑战后的感觉.而这时你应该:哟哟,快使用SmartDoc: SmartDoc, 一个基于NodeJS的自动化文档生成工具,她拥有明眸的双眼(yuidoc引擎),华丽的外衣(bootstrap 3风格),灵巧的双手(demo生成,codemirror代码编辑,jasmine接口兼容);拥有她,相信你一定会仰天长啸:"小伙伴们再也不用担心…

==========最终的效果图========== ==========下面开始干活:生成帮助文档========== 一.创建 WebApi 项目 二.找到 HelpPageConfig.cs 并取消代码注释 config.SetDocumentationProvider( new XmlDocumentationProvider ( HttpContext.Current.Server.MapPath( "~/App_Data/XmlDocument.xml" ))); 三.对项…

官方文档连接:http://apidocjs.com/#demo apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java.C.C#.PHP和Javascript等.使用者仅需要按照要求书写相关注释,就可以生成可读性好.界面美观的在线接口文档.本文主要包含以下内容: 介绍apidoc的基本概念 安装.使用和简单配置 一些特殊参数的含义及其使用 介绍一些使用经验 前言 apidoc能做什么 apidoc是一个轻量级的在线REST接口文档生成系统,可以根据其特定的规则的…

概述 知识与思路 代码实现 概述 Markdown 很适合于技术写作,因为技术写作并不需要花哨的排版和内容, 只要内容生动而严谨,文笔朴实而优美. 为了编写对读者更友好的文章,有必要生成文章的标题导航,让读者有个预期的阅读概览.当文章标题比较多时,手工去编写导航锚点比较费时,因此决定使用Python解析Markdown文档自动生成标题导航. 知识与思路 写过Markdown的人知道,Markdown的标题是使用一到六个# 左右包围住标题文字,而锚点是 [标题](#标题). 比如 ## 知识与思路…

Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为什么选择swagger,现在的网站开发结果越来越注重前后端的分离,比如以前的webFrom到现在的mvc模式都是为了这个前后端的分离.就算再如何的分离实现,也是不可避免的要进行数据交互的,那么接口的重要性就提现出来了.他成了前端和后端交互的重要途径,API文档也因此成了前端开发人员与后端开发人员的重要纽带.…

watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQv/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center" alt=""> 一.----------------------------------------------------------jQuery.validate 表单验证 二.---------------------------…

在老大的指引下,需要将系统的json文件格式转换成apidoc的json格式,也就是json格式的重组,但是这个apidoc的生成格式是不固定的,因为apidoc有自己一套的生成规则,我需要研究一下是怎么生成的. 一.官方基础栗子 二.理解apidoc生成静态文档的结构解读 三.深入理解一下apidoc生成原理以及规则 一.apidoc基础栗子 全局安装apidoc npm install apidoc -g 1.首先建立文件目录 2.需要你在input文件夹里面写上你的js部分 这个是栗子的j…

Lodop获取全部JS代码,传统JS模版的生成.LODOP设置打印设计返回JS代码是变量 LodopJS代码模版的加载和赋值 Lodop生成文档式模版 LodopJS文档式模版的加载和赋值 由于加载JS传统模版,需要非Lodop方法的eval,该JS方法也介绍了一下:JS-JAVASCRIPT的eval()方法 注意,分页分任务的时候:如果模版是带初始化语句的,可以循环多任务,什么是一个任务,参考本博客相关博文:Lodop打印语句最基本结构介绍(什么是一个任务) 如果想要一个任务里分页,可循环去…

工作中,我们时常会遇到一些操作文件的操作,比如在线生成合同模板,上传/下载/解析Excel,doc文档转为pdf等操作.本文就已工作中遇到的在线生成合同为例,简要地介绍一种文档替换写法. 本文目的:给出源文件模板,通过程序操作后,替换模板中的指定内容,从而生成固定模板的文件. 使用场景:生成固定格式的合同信息. 原理:给一个文档模板,需要替换的内容以 $$包含,然后,在代码中给需要替换的字段赋值,生成新的文档. 工具包:poi-ooxml-3.10.jar   自己网上下载 代码: packag…