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. 跨…

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内嵌, 安卓平…

前言 日常开发业务代码,新接手一块不熟悉的业务时需要频繁的查看对应业务的数据库表设计文档.相比于直接翻看业务代码,有必要提供一个数据库表结构文档查看器来解决这些繁琐的问题. 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…