Atitit 项目的主体设计与结构文档 v5 1. 版本历史说明2 2. 功能大概说明2 3. 实现的目标3 3.1. cross device跨设备(pc 手机 平板)3 3.2. cross screen跨不同屏幕(pc,手机,平板等尽可能兼容大小不同屏幕)3 3.3. 跨语言标准化api3 3.4. 高扩展性(为以后不断的修改留下很好的余地以及较为容易的扩展3 3.5. 兼容性3 3.6. 源码可读性dsl提升,(为以后维护修改方便维护性3 3.7. 跨平台(微信平台等app内嵌, 安卓平…

Atitit 项目的主体设计与结构文档 v3 1. 实现的目标2 1.1. cross device跨设备(pc 手机 平板)作为规划2 1.2. 企业级Java体系与开发语言2 1.3. 高扩展性,高维护性,方便后期维护2 1.4. cross screen跨不同屏幕(兼容小屏幕)作为规划2 1.5. 跨语言标准化api2 1.6. 兼容性 与多版本管理3 1.7. 可读性dsl3 1.8. 跨平台规划,前期主要pc(微信平台等app内嵌,独立app内嵌,pc与手机与平板平台)3 1.9. 跨…

前言 日常开发业务代码,新接手一块不熟悉的业务时需要频繁的查看对应业务的数据库表设计文档.相比于直接翻看业务代码,有必要提供一个数据库表结构文档查看器来解决这些繁琐的问题. CML.SqlDoc CML.SqlDoc 是基于netcore开发的数据库表结构文档查看器,通过简单的配置部署即使用, 数据库表结构文档查看器支持MSSql MySql多数据库 界面呈现 如何部署 *appsettings.json 数据库连接以及库名写入配置文件 格式如下 { "ConnectionStrings&quo…

Tips <Effective Java, Third Edition>一书英文版已经出版,这本书的第二版想必很多人都读过,号称Java四大名著之一,不过第二版2009年出版,到现在已经将近8年的时间,但随着Java 6,7,8,甚至9的发布,Java语言发生了深刻的变化. 在这里第一时间翻译成中文版.供大家学习分享之用. 19. 如果使用继承则设计,并文档说明,否则不该使用 条目 18中提醒你注意继承没有设计和文档说明的"外来"类的子类化的危险. 那么为了继承而设计和文档…

HTML结构文档中那些基础又重要又容易被忽略的事? 大部分的人,总是会做出这样下意识地判断:简单就是不重要,容易就可以直接忽略掉!其实不然,简有精髓,基石必重,岂能略而不顾!HTML结构文档的编写,可以说是入手简易,繁杂靠边!就是因为这样,很多前端开发者往往会忽略其重要性?不信,那我就来说说HTML结构文档编写开发中,那些容易被忽略的事吧! 居于HTML文档之首的DOCTYPE? 如果问DOCTYPE是什么?大家都会回答是文档声明.问为什么需要加上它?相信很多人会说,我看到其他人或者前辈们都是这…

对于DBA或开发来说,如何规范化你的数据库表结构文档是灰常之重要的一件事情.但是当你的库,你的表排山倒海滴多的时候,你就会很头疼了. 推荐一款工具DBExportDoc V1.0 For MySQL(MySQL数据库表结构导出器). 介绍: DBExportDoc V1.0 For MySQL是一款利用office特性VBA开发的小工具,利用此工具可以将本机MySQL上任意数据库.任意表的数据结构导出.但是它不是一款你安装是一路next到finish就可以立刻使用的. 要注意的有两点: 首先,你…

作者:wide288 , 日期:2013-7-31 以前开发中,用 MYSQL 数据库,有个小程序 生成数据库结构文档.很方便,做为开发组的文档很有用. 现在开发中用到了 SQL SERVER 2008 ,当然也要写一个同样的东西. 大体原理: 1,查sql server 2008 中数据库的所有表的名称和ID SELECT name, id From sysobjects WHERE xtype = 'u' ORDER BY name ASC 2,通过表名,查表的结构与注释 select sy…

对于DBA或开发来说,如何规范化你的数据库表结构文档是灰常之重要的一件事情.但是当你的库,你的表排山倒海滴多的时候,你就会很头疼了. 推荐一款工具DBExportDoc V1.0 For MySQL(MySQL数据库表结构导出器). 介绍: DBExportDoc V1.0 For MySQL是一款利用office特性VBA开发的小工具,利用此工具可以将本机MySQL上任意数据库.任意表的数据结构导出.但是它不是一款你安装是一路next到finish就可以立刻使用的. 要注意的有两点: 首先,你…

前言 为什么在开发中,接口文档越来越成为前后端开发人员沟通的枢纽呢? 随着业务的发张,项目越来越多,而对于支撑整个项目架构体系而言,我们对系统业务的水平拆分,垂直分层,让业务系统更加清晰,从而产生一系统平台和系统,并使用接口进行数据交互.因此可见,业务的不断发展,接口不断增多,很多接口各自寄宿在不同的项目中,如果没有使用api工具进行管理,那么使用和说明将变得非常复杂.所以,接口管理运营应运而生. 在过去的开发中,没有API文档管理工具之前,很多的API文档在什么地方写的都有,有在word写的,…

前言 回顾上一篇文章<使用Swagger做Api文档 >,文中介绍了在.net core 3.1中,利用Swagger轻量级框架,如何引入程序包,配置服务,注册中间件,一步一步的实现,最终实现生产自动生产API接口说明文档.文中结尾也留下了一个让大家思考的问题.在这里,我们重新回顾一下这几个问题   1. 已经有接口了,但如何添加注释呢?   2. 作为接口使用者,我们关心的是接口的返回内容和响应类型,那我们如何定义描述响应类型呢?   3. 在项目开发中,使用的实体类,又如何在Swagger…

Web项目中生成Word文档的操作屡见不鲜.基于Java的解决方式也是非常多的,包含使用Jacob.Apache POI.Java2Word.iText等各种方式,事实上在从Office 2003開始.就能够将Office文档转换成XML文件,这样仅仅要将须要填入的内容放上${}占位符,就能够使用像Freemarker这种模板引擎将出现占位符的地方替换成真实数据,这种方式较之其它的方案要更为简单. 以下举一个简单的样例.比方在Web页面中填写个人简历,然后点击保存下载到本地.效果图例如以下所看到…

上一篇: [WEB API项目实战干货系列]- Web API 2入门(一) 这一篇我们主要介绍如何做API帮助文档,给API的调用人员介绍各个 API的功能, 输入参数,输出参数, 以及在线测试 API功能(这个也是方便我们自己开发调试) 我们先来看看我们的API最终帮助文档及在线测试最终达到的效果: 概要图   GET API 添加产品API: 删除产品 API 接下来我们动手来实现上面的功能 给所有API添加注释信息 代码如下 [RoutePrefix("api/products"…

Swagger简介. Swagger2是一款restful接口文档在线生成和在线调试工具.很多项目团队利用Swagger自动生成接口文档,保证接口文档和代码同步更新.在线调试.简单地说,你可以利用这个工具生成你的接口文档而不是自己去写,而且生成的文档在网站上可以让别人调试. 开发环境 Eclipse+Maven+Swagger2 具体步骤 引入Maven依赖.(很多JAVA组件使用的第一步) 我的maven坐标如下 <dependency> <groupId>io.springfo…

为什么还要写这类文章?因为我看过网上很多讲解的都不够全面,而本文结合实际工作讲解了swaggerui文档,统一响应格式,异常处理,权限验证等常用模块,并提供一套完善的案例源代码,在实际工作中可直接参考使用. 一.先看看最终效果 这是最后生成的swagerui文档,大家可以直接访问这个地址体验: http://sapi.daimali.com/swagger/ui/index (若无法访问,请公众号CodeL联系) git源码地址:https://gitee.com/daimali/WebApiD…

这段时间项目中使用了freemarker生成word文档.在项目中遇到了几个问题,在这里记录一下.首先就是关于遍历遇到的坑.整行整行的遍历是很简单的,只需要在整行的<w:tr></w:tr>的标签钱加上遍历的<#list  list as list> </#list>就行了.我在这里要说的是前面还有合并单元格的时候的情况.如下图,水泥路面和沥青路面这几行属于申请占用面积的子行.在这里遍历的时候就需要注意.按照html的格式的话,肯定会将这整个刚做一个tr.然…

    表名:dede_addonarticle(ENGINE=MyISAM/CHARSET=gbk) 说明:Top 字段名 说明描述 具体参数 aid 文章ID mediumint(8) unsigned NOT NULL default '0' typeid 栏目ID smallint(5) unsigned NOT NULL default '0' body 内容 mediumtext redirecturl 跳转URL varchar(255) NOT NULL default '' t…

点击Report->Reports 点击New Report 选择Standard Physical Report,语言选择简体中文,如下图 此时目录下就会多一个Report 右窗口: 根据自己的需要对右边Report items进行取舍,我在此选了最基本的表清单以及每个表的字段清单,如下 对package中的表的栏清单点击右键->Layout选择所需显示字段的属性 比如我需要字段的名称 代码 数据类型和注释 就勾选: 如果对生成的文档有字体等格式要求,可以对所需的行 右键->Forma…

只说原理了,具体 可以自己使用程序去生成htm或word文档. 1.首先获取所有的表 SELECT name, id From sysobjects WHERE xtype = 'u' ORDER BY name ASC 2.根据表名查询字段信息 select syscolumns.name, syscolumns.length, systypes.name   as   typename, sys.extended_properties.[value] AS tname,syscolumns.…

表名:dede_addonarticle(ENGINE=MyISAM/CHARSET=gbk)   字段名 说明描述 具体参数 aid 文章ID mediumint(8) unsigned NOT NULL default '0' typeid 栏目ID smallint(5) unsigned NOT NULL default '0' body 内容 mediumtext redirecturl 跳转URL varchar(255) NOT NULL default '' templet 自定…

import java.awt.Color; import java.io.FileOutputStream; import java.sql.Connection; import java.sql.DriverManager; import java.sql.ResultSet; import java.sql.SQLException; import java.sql.Statement; import java.util.ArrayList; import java.util.HashMa…

一.环境1. JAVA82. MAVEN 3.0.53. IDEA 2016.2.54. spring boot 1.4.1 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency> <dependency…

Atitit 项目文档规范化与必备文档与推荐文档列表 ===========比较重要的必备文档========== 项目组名单通讯录( 包括项目组,客户沟通人等 需求文档 原型ui文档 开发计划表 项目源码与架构文档以及新结构文档 设计文档 (一般概要即可,重点模块单独详细设计) 数据库文档 注意事项 =========对开发比较重要的文档 Svn源码服务器账号密码 测试数据库账号密码信息 数据库sql脚本文件. 开发环境搭建文档 项目技术规范文档.(项目模式和产品模式有很多不同,需要单独分离)…

博客公告: (1)本博客全部博客文章搬迁至<博客虫>http://blogchong.com/ (2)文章相应的源代码下载链接參考博客虫站点首页的"代码GIT". (3)很多其它的相关文章更新,以及代码等.请关注博客虫站点,站点中有技术Q群,以及代码共享链接. (4)该博客内容还会继续更新,只是会慢一些. 该文档为实实在在的原创文档,转载请注明作者及出处. 类型 具体 备注 ² 该文档为原创模拟项目:流数据监控<1>文档<流数据监控设计文档>.相继会…

当我们发布一个开源项目的时候,最重要的事情之一就是要创建项目文档.对使用项目的用户来说,文档是非常有必要的,通常我们可以使用下面这些方式来创建文档: GitHub Wiki:在 Github 上我们可以为每个项目都创建一个 wiki.Wiki 是由一系列的 Markdown 文件组成,所以我们可以用 wiki 来做项目文档.但这种方案也有一些缺点:wiki 的贡献者不会出现在项目贡献者列表中:文档的结构和布局都是有限制的,只能是 Github Wikis 的样式:文档存储在第三方平台上. REA…

目录 1.什么是Gitlab Pages 2.开启Gitlab Pages 3.基本过程 4.托管markdown文档 4.1 安装sphinx等依赖 4.2 配置项目的sphinx配置 4.3 编写项目文档 4.4 创建首页索引 4.5 配置gitlab-ci.yml 4.6 生成网页 4.7 配置DNS或者hosts文件 5.预览和调试 5.1 直接使用sphinx命令生成网页 5.2 VScode+sphinx插件预览 5.3 下载Gitlab生成的网页 总结 这段时间准备软考去了,也挺久…

最近在项目开发中遇到下载附件文档预览需求,在这里总结一下我的实现方法,本文最后会附带我写的demo下载地址 这里我总结了三种实现方法(1)用webView预览(2)通过UIDocumentInteractionController实现跳转(3)应用Quick Look系统框架,下面依次介绍各个方法实现 首先来看用webView这个比较常用,不做过多解释,代码如下: _webView = [[UIWebView alloc]initWithFrame:self.view.bounds]; _web…

在很多文档管理的功能模块里面,我们往往需要对WORD稳定进行展示.编辑等处理,而如果使用微软word控件进行处理,需要安装WORD组件,而且接口使用也不见得简单易用,因此如果有第三方且不用安装Office的能够展示WORD及进行编辑,那是比较不错的选择,TX Text Control就是这样的控件,本文就是基于这个控件的使用,实现在文档管理项目中的应用. 1.TX Text Control的介绍及使用 TX Text Control是一款功能类似于 MS Word 的文字处理控件,包括文档创建.…

今天从git上面导入项目之后,由于是上周刚刚提交过的,本地也没有什么修改,于是就从gitlab上面直接下载下来了.可是项目启动时候,报错了... 文档中根元素前面的标记必须格式正确 想想 原来是上次提交代码的时候,我把项目的.git也提交上了.这次更新的时候,把.git 也更新了下来.解决办法是 删除项目的.git 重启就好了.…

1,  建立或打开项目后,在“程序包管理器控制台”中执行以下命令添加包引用: Install-Package Swashbuckle.AspNetCore 2,在项目中打开Startup.cs文件,找到 Configure 方法,在其中添加如下代码: app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "MsSystem API V1")…

在写本系列的过程中,了解得越多越不知道从哪里做为切入点来写,几乎每个知识点展开来说都可以写成一本书.而自己在写作与文档编写方面来说,还是一个初鸟级别,所以只能从大方面说说,在本框架开发所需的范围内来讲述相关要用到的知识点,至于要更深入的去了解,请大家观看其他大牛的博客或购买书籍来学习. 为了加快进度,会对目录进行修改,将一些知识点合并或在后面使用的章节再进行描述. 谢谢大家的支持,如果您觉得本文对您有所帮助,请帮忙点击支持或发表评论. 在开发的过程中,要编写各种各样的文档,当然也有不少公司根本就…