1.下载 Java SE Development Kit 8 Documentation . 2.启动Eclipse,Window-Preference-Java-Installed JREs: 3.定位到api文件夹: 4.光标定位到要查询的代码,‘F1’打开‘Help’:…

关于ASP.NET Web Api的HelpPage文档注释问题 以前我用微软的HelpPage来自动生成的webAPI帮助文档.在使用了一段时间后发现只能显示Controller上面写的注释文档内容.以前总以为是微软这个类库的bug.后来才明白了是由于我的设置不当. 微软的HelpPage类库 controller上的注释 AlarmRecodrdDto文档 我们可以很清楚的看到,返回的`AlarmRecodrdDto`并没有注释文档啊!可是我已经在类库的中写过了该代码的注释的.为毛就没有呢?…

Tips 书中的源代码地址:https://github.com/jbloch/effective-java-3e-source-code 注意,书中的有些代码里方法是基于Java 9 API中的,所以JDK 最好下载 JDK 9以上的版本. 56. 为所有已公开的API元素编写文档注释 如果API要可用,就必须对其进行文档化.传统上,API文档是手工生成的,保持文档与代码的同步是一件苦差事.Java编程环境使用Javadoc实用程序简化了这一任务.Javadoc使用特殊格式的文档注释(通常称为…

开源地址:http://git.oschina.net/chejiangyi/ApiView 开源QQ群: .net 开源基础服务  238543768 ApiView .net api的接口文档查看网站,用于解决分布式开发过程中的Api接口管理和沟通问题. - 自动生成api文档: - 方便api调试及第三方开发人员对接,可以应用在asp.net mvc,wcf,webservice 中使用: - 代码及原理都很简单,方便二次开发和完善. 安装包 使用git下载项目并打开目录 “\安装包\”…

目录 1 添加文档的细节 1.1 注册观察者 - watcher 1.2 文档的路由 - document route 1.2.1 路由算法 1.2.2 Solr路由的实现类 1.2.3 implicit路由算法的使用 1.2.4 Solr获取文档Hash值的要求 2 添加索引的过程 3 更新索引的过程 4 Solr创建和更新索引的总结 4.1 Leader的转发规则 4.2 高效实践的建议 1 添加文档的细节 1.1 注册观察者 - watcher Solr单机服务中, 与Solr内部进行交互…

一.XML语言 XML是一种可扩展的标记语言,是一种强类型的语言,类似HTML(超文本标记语言,是一种弱类型的语言).XML是一种通用的数据交换格式(关系型数据库),综上所诉:XML可以传输数据,也可以存储数据. 1.XML语言书写的注意事项 1.XML标签命名自定义[推荐英文],标签名中不能包含空格 2.XML空格和换行都表示数据,严格区分大小写 3.XML中特殊字符表示的数据需要使用特殊字符编码和HTML一样 4.CDATA区中的数据不会被识别为语法 <![CDATA[王天霸<>&l…

  Spring Boot Swagger2 集成REST ful API 生成接口文档 原文 简介 由于Spring Boot 的特性,用来开发 REST ful 变得非常容易,并且结合 Swagger 来自动生成 REST ful API 文档变得方便快捷. Swagger 是一个简单但功能强大的API表达工具.几乎所有的语言都可以找到与之对应的Swagger 版本.使用Swagger生成API,我们可以得到交互式文档.听过Spring Boot 与Swagger 的结合,生成更加完备的RE…

本文介绍通过Java程序添加OLE对象到Excel文档.OLE分为两种形式,一种通过嵌入(Embed),方式,一种通过链接(Link)方式.前者是将对象嵌入到文档中,外部对该对象的更改不影响嵌入操作时的对象:后者是以链接形式来保存对象,外部任何对该对象的更改都会影响文档.这里的对象,支持多种不同类型(如下图),如PDF.Word.Excel.PPT等常见格式的文档类型. 本文中的Java代码示例以Word文档为对象通过嵌入方式添加到Excel工作表的指定单元格,代码可供参考. 工具:Free S…

01_帮助文档的制作和使用 制作说明书的流程 如何制作一个说明书呢? A:写一个工具类 B:对这个类加入文档注释 怎么加呢? 加些什么东西呢? C:用工具解析文档注释 javadoc工具 D:格式 javadoc -d 目录 -author -version ArrayTool.java 目录:就可以写一个文件夹的路径 制作帮助文档出错: 找不到可以文档化的公共或受保护的类:告诉我们类的权限不够----工具类前面要加public 写一个工具类,对这个类加入文档注释 /** * 这是针对数组进行操…

asp.net core web api 生成 swagger 文档 Intro 在前后端分离的开发模式下,文档就显得比较重要,哪个接口要传哪些参数,如果一两个接口还好,口头上直接沟通好就可以了,如果接口多了就有点不适用了,没有接口文档会大大提高前后端的沟通成本.而 asp.net core 可以通过 Swashbuckle.AspNetCore 很方便的集成 swagger 文档,相比之下 nodejs(express) 和 swagger 集成就很麻烦了,大概这就是强类型语言的优势吧.C#…

微信公众号怎么添加附件?比如word文档,pdf文件等   我们都知道创建一个微信公众号,在公众号中发布一些文章是非常简单的,但公众号添加附件下载的功能却被限制,如今可以使用小程序“微附件”进行在公众号中添加附件. 以下是公众号添加附件使用“微附件”小程序的教程: 电脑端使用“微附件”: 大体上分为两步:第一步:将附件上传到“微附件”小程序,或官方网站,这里只演示上传到官网的.第二步:在微信公众号后台操作就可以了.1.进入官方网站,上传附件,注意一下路径,后面要用. 2.已关联过小程序的按照下面…

个人比较偏爱links的方式,以下方式eclipse/myeclipse均适合 1.links方式 在eclipse目录先新建links目录,新建一个xx.link(例如:android.link) 在android.link中写上path=E:/android/adt,目录一直到解压插件中的features和plugins目录中的上一级即可 2.直接复制 将features和plugins直接合并到eclipse/myeclipse目录下 3.Install方式: 3.1.点击Add 3.2.…

源代码 Source 按住 Ctrl 键,鼠标放到对应的类.方法上,出现 Open Declaration,Open Implementation ,可查看对应的实现.声明源代码. 也可以在[Project Explorer]视图中,Libraries 下找到相应的类,打开即可查看源代码. 如果没有源代码,则会出现 "Source not found",[Attach Source...]按钮可配置. 也可以在 [Project Explorer]视图中,对应项目的 "Jav…

原文:ASP.NET Web API Help Pages using Swagger 作者:Shayne Boyer 翻译:谢炀(kiler) 翻译:许登洋(Seay) 对于开发人员来说,构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战. 在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你创建良好的文档和帮助页面. Swashbuckle 可以通过修改 Startup.cs 作为一组 NuGet 包方便的加入项目…

SwaggerUI 可以生成不错的文档,但默认只能作用于单个api 项目,研究了一下源码发现只需修改一下SwaggerConfig.cs文件即可支持多API项目 1.使用生成脚本把xml文件复制到API主项目. 2.修改SwaggerConfig.cs,注释掉c.IncludeXmlComments(GetXmlCommentsPath()),添加 AddXm方法 如下: 参考文章:http://www.cnblogs.com/Arrays/p/5146194.html…

前言: 前一段时间一直都比较忙,没有什么时间进行总结,刚好节前项目上线,同时趁着放假可以好好的对之前遇到的一些问题进行总结.主要内容有使用SharePoint服务端对象模型进行查询.为SharePoint 自定义列表项添加callout菜单.希望能够给大家带来一些帮助. 1.  在aspx页引用可视化Web部件 有时候会需要在页面中引用项目中创建的可视化Web部件,具体步骤有以下这几步: 1) 在aspx页面顶部注册该可视化Web部件 示例如下: <%@ Register Tagprefix=&qu…

使用Word API(非Openxml)打开Word文档简单示例(必须安装Word) 首先需要引入参照Microsoft.Office.Interop.Word 代码示例如下: public void OpenWord() { // Word应用对象 Word.Application wdApp = null; // Word文档对象 Word.Document wdDoc = null; // Word路径 object oWdPath = "XXXXXXXXXXXXXX"; //…

一.前言 通常我们的项目会包含许多对外的接口,这些接口都需要文档化,标准的接口描述文档需要描述接口的地址.参数.返回值.备注等等:像我们以前的做法是写在word/excel,通常是按模块划分,例如一个模块包含n个接口,就形成一个文档,然后再用版本控制管理.这样做的缺点是: 1.不够直观,每次打开文档查看接口很麻烦 2.文档的维护难度大 3.调用方和测试人员使用麻烦,需要先去找接口,在用相应的工具测试(例如使用浏览器还可能要安装插件) 我们希望是可以直接在线浏览,然后直接用浏览器测试.而接口的详细…

这篇文章http://www.cnblogs.com/landeanfen/p/5210356.html写得比较详细, 我就挑简单的来说. 首先用这功能要在WEB API创建的帮助文档下面,如果你使用了web helper另外建的帮助文档,注意引用页面脚本跟样式,否则可能达不到你想要的效果. 使用NuGet,搜索WebApiTestClient,安装. 安装完成后,在 Areas\HelpPage\Views\Help) Api.cshtml 后面添加这个就可以了. @Html.DisplayF…

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency> 上述jar包中,已经有关于logging的定义了 用的时候,直接添加记录器 // 记录器Logger logger = LoggerFactory.getLogger(getClass()); 日志的…

一.前言 通常我们的项目会包含许多对外的接口,这些接口都需要文档化,标准的接口描述文档需要描述接口的地址.参数.返回值.备注等等:像我们以前的做法是写在word/excel,通常是按模块划分,例如一个模块包含n个接口,就形成一个文档,然后再用版本控制管理.这样做的缺点是: 1.不够直观,每次打开文档查看接口很麻烦 2.文档的维护难度大 3.调用方和测试人员使用麻烦,需要先去找接口,在用相应的工具测试(例如使用浏览器还可能要安装插件) 我们希望是可以直接在线浏览,然后直接用浏览器测试.而接口的详细…

Elasticsearch的更新文档API准许通过脚本操作来更新文档.更新操作从索引中获取文档,执行脚本,然后获得返回结果.它使用版本号来控制文档获取或者重建索引. 我们新建一个文档: 请求:PUT http://localhost:9200/test/type1/1?pretty 参数: { , "tags" : ["red"] } 脚本开启功能 在最新版本的Elasticsearch中,基于安全考虑(如果用不到,请保持禁用),默认禁用了动态脚本功能.如果被禁用,…

对特定元素添加超链接后,用户可以通过点击被链接的元素来激活这些链接,通常在被链接的元素下带有下划线或者以不同的颜色显示来进行区分.按照使用对象的不同,链接可以分为文本超链接,图像超链接,E-mail链接,锚点链接,多媒体文件链接,空链接等多种链接,本篇文章中将介绍在Word中添加以下几种常见超链接的方法,包括: 1. 网页链接 1.1 给文本添加网页链接 1.2 给图片添加网页链接 2. 添加文档链接 3. E-mail邮箱链接   使用工具:Free Spire.Doc for Java (免…

系列导航及源代码 使用.NET 6开发TodoList应用文章索引 需求 在日常开发中,我们需要给前端提供文档化的API接口定义,甚至需要模拟架设一个fake服务用来调试接口字段.或者对于后端开发人员来说,我们可以通过导入这个接口定义文件到Postman或者其他API客户端,省去我们手动录入的麻烦.所以本文就实现如何使用Swagger来管理API接口文档化. 但是在本文中,我们不涉及关于NSwag的相关内容,通过NSwag,我们甚至可以直接生成前端可以使用的接口定义.关于NSwag的使用方法,请…

初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份文档维护起来就很困难了.于是发现了swagger,自动生成文档的工具. swagger介绍 首先,官网这样写的: Swagger – The World's Most Popular Framework for APIs. 因为自强所以自信.swagger官方更新很给力,各种版本的更新都有.swag…

简而言之,要为API编写文档,文档注释是最好,最有效的途径.对于所有可导出的API元素来说,使用文档注释应该被看作是强制性的.要 采用一致的风格来遵循标准的约定.记住,在文档注释内部出现任何的HTML标签都是允许的,但是HTML元字符必须要经过转义.…

具体参数可以参考一下: 参数 类型 描述 Width 字符串 控制 宽度 样式属性的Select2容器div minimumInputLength int 最小数量的字符 maximumInputLength int 最大数量的字符 minimumResultsForSearch Int 最小数量的结果 maximumSelectionSize int 可选择的最大条目数 placeholder 字符串 选择初始值 separator 字符串 分隔符字符或字符串用来划定id allowClear…

初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份文档维护起来就很困难了.于是发现了swagger,自动生成文档的工具. swagger介绍 首先,官网这样写的: Swagger – The World's Most Popular Framework for APIs. 因为自强所以自信.swagger官方更新很给力,各种版本的更新都有.swag…

3 前端渲染和后端渲染 这两种渲染都属于动态页面 区分前后端渲染的关键点是站在浏览器的角度 3.1 后端渲染 浏览器请求服务器后获取到的是完整的HTML页面(即:后台已经组装好HTML文件啦),利用flask模板渲染出来的都是后端渲染 特点: 可维护性不好(前后端开发人员编写的代码有交叉) SEO(即:在百度中容易搜索到)友好,因为页面是完整的,搜索引擎能获取到更多的数据 服务器压力大,服务器需要承担模板渲染的任务 3.2 前端渲染 浏览器请求服务器后获取到的是HTML页面模板和数据,浏览器执行…

一个非侵入的api编译.收集.Rest文档生成工具.工具通过分析代码和注释,获取文档信息,生成RestDoc文档 前言 程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一致.docstring说白了就是一堆代码中的注释.Python的docstring可以通过help函数直接输出一份有格式的文档,本工具的思想与此类似. 代码即文档 Apigcc是一…