1.为什么要写Api文档 现在,前后端分离的开发模式已经非常流行,后端开发工程师只负责完成后端接口,前端页面的开发和渲染完全由前端工程师完成. 问题来了,前端工程师怎么知道后端接口的具体定义呢?答案是由后端工程师撰写. 2.写Api文档很头疼吗 答案是一定的,这对后端工程师来说,是额外的工作,编码已经很耗费精力了,这时前端工程师来催文档,不头疼才怪:),当然这也不是前端工程师的问题,都是为项目的进度着急. 3.Swagger2 现在好了,一个自动撰写Api文档的神器出现了,他就是 Swagger…

你会用AngularJS,但你会写AngularJS文档么? 涉及知识:gulp javascript 我们经常在写代码的时候要求写好注释,方便日后维护.但其实注释还有一个重要的用途:生成API文档. 文档意义 API文档有什么用?避免多人开发时出现重复造轮子(轮子都在文档上).方便新加入项目的开发人员了解公用函数/组件.方便所有开发人员查阅公用函数/组件的入参和出参以及调用方式.... 实际问题 前端API文档生成有著名的工具jsdoc.公司项目采用gulp构建工具和AngularJS的框架,…

看云 写帮助文档 | 专注于文档在线创作.协作和托管 https://www.kancloud.cn/manual/thinkphp/1678 https://www.gitbook.com/…

swagger简介 官方的介绍 THE WORLD'S MOST POPULAR API TOOLING Swagger is the world's largest framework of API developer tools for the OpenAPI Specification(OAS), enabling development across the entire API lifecycle, from design and documentation, to test and…

使用docsify 写开源文档 官网:https://docsify.js.org/#/ docsify 是一个动态生成文档网站的工具.不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行. 这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件"污染" commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages. 一.初始化…

目录 前言 (思维篇)人人都是产品经理 1.需求文档 1.1 需求管理 1.2 如何攥写需求文档 1.3 需求关键点文档 2 原型设计 2.1 缺失的逻辑 2.2 让想法跃然纸上 3 开发设计文档 3.1 功能梳理 3.2 数据库设计 4 制定开发任务和计划 4.1 时间管理 4.2 任务管理(任务拆分+排期) (技术篇) 码农的自我修养 5 Java基础 5.1 Java环境搭建 5.2 Java基本语法 5.3 Java流程控制 5.4 Java 集合 5.5 Java 类与对象 5.6 构…

//C#写TXT文档 String strDir = System.IO.Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().GetName().CodeBase); string filePath = strDir + "\\putin.txt"; FileStream fs = new FileStream(filePath, FileMode.Append); StreamWriter s…

前言 之前想用Markdown来写框架文档,找来找去发现还是Jekyll的多,但又感觉不是很合我的需求 于是打算自己简单弄一个展示Markdown文档的网站工具,要支持多版本.多语言.导航.页内导航等,并且支持Github Pages免费站点 组件选择 我自己呢比较喜欢C#,恰好现在ASP.Net Core Blazor支持WebAssembly,绝大部分代码都可以用C#完成 对于Markdown的分析,可以使用markdig组件(有个缺点,目前它把生成Html的代码也放到了程序集里,增加了不少…

上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown基本语法也没啥好说的,随便百度一下几分钟看懂基本的,20%的知识完成80%的任务嘛,够了. 关键在于,我有些特殊需求,以方便将Markdown作为接口文档查看.什么需求呢? 目录.这是重中之重.没有方便的TOC的话,文档长了,查看起来真是费劲.我理想中的目录是这样的: 根据H1(# ).H2(## …

官方手册:https://perldoc.perl.org/perlpod.html POD文档是perl的man文档,可以用perldoc输出,也可以直接用man输出.在开始下面的文章之前,请先粗略浏览一到两篇perldoc文档,或去CPAN找几个模块的文档浏览下大致格式. 例如: $ perldoc Data::Dumper $ man Data::Dumper 执行perldoc的时候,perldoc会搜索@INC下的Data/Dumper.pm和Data/Dumper.pod文件. PO…