代码规范、API设计等规范】的更多相关文章

一份整理好了的规范文档,node后端开发用到 "规范是个好东西..." - 鲁迅 以下规范仅作为参考 1.代码规范 命名 尽量保证命名更加语义化 文件命名采用下划线命名法 // good service_center.js // bad serviceCenter.js 类 & 构造函数命名 类命名采用 Pascal命名法,大写字母开头,各个单词首字母大写 class Person { constructor(name) { this.name = name; } } cons…
RESTful API设计原则与规范 一.背景与基础概念 2 二.RESTful API应遵循的原则 3 1.协议(Protocol) 3 2.域名(ROOT URL) 3 3.版本(Versioning) 3 4.路径(Endpoints) 3 5.HTTP动词(HTTP Verbs) 4 6.过滤信息(Filtering) 5 7.状态码(Status Codes) 5 8.错误处理(Error handling) 6 9.返回结果(Response) 6 10.使用HATEOAS的Hype…
以下转载于:http://www.it28.cn/ASPNET/825095.html 下面这个规范是我为朋友写的几点建议,写的很范,作为BLOG,愿与大家一起分享.只给出部分设计规范样例,关于.NET编程的详细规范.设计请参考相关书籍. 1.命名规范 1.1    命名空间命名,一般命名为”公司简称+产品名称+程序包”的形式,如ARSC.EngineMap.Geometry.SharpMap.Framework.SharpMap.Controls.GoogleMap.Downloader.Go…
整体规范建议采用RESTful 方式来实施. 协议 API与用户的通信协议,总是使用HTTPs协议,确保交互数据的传输安全. 域名 应该尽量将API部署在专用域名之下.https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下.https://example.org/api/ api版本控制 应该将API的版本号放入URL.https://api.example.com/v{n}/另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和…
Atitit usrQBF2312 命名空间pkg 以及 api命名 spec规范 简化英文1 常用类库sdk的命名单词统计表1 简化时间规则1 Namsspace nam spec,参照java .net 传输sdk1 Api命名规则1 参考知名api,比如游戏api参考cocos2d,这样可以大大减少资料文档的编撰..互联网上已经有了..1 3  接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如interface Runna ble ;      …
Web UI 网站用户界面设计命名规范 WEB UI设计命名规范,也就是网站用户界面设计(网页设计)命名规范. 这套规范并非单纯的CSS.html或JavaScript命名规范,它涉及了很多使用PhotoShop这类设计工具进行网页设计过程中的命名规范. 许多美工设计效果图源文件没有对图层命名的习惯,而网上大多命名规范都是关于css.html.js和一些服务器端语言的,设计方面的命名规范很 少.设计师也是技术团队的成员,而前端开发工程师需要使用设计师的效果图源文件的,所以统一命名规范和设计规范对…
(2.15)Mysql之SQL基础——开发设计最佳规范 关键字:mysql三大范式,mysql sql开发规范 分析: show profile.mysqllsla.mysqldrmpslow.explain show slow log; show processlist; show query_response_time(percona); 1.数据库三大范式 2.生产环境的基础规范 3.命名规范 4.表设计规范 5.字段设计规范 6.索引设计规范 7.SQL使用规范 8.其他常用规范 1.数…
# vscode保存代码,自动按照eslint规范格式化代码设置 编辑器代码风格一致,是前端代码规范的一部分.同一个项目,或者同一个小组,保持代码风格一致很必要.就拿vue项目来说,之前做的几个项目,很多小伙伴代码格式化用的是vue-beautify ,这个格式化工具有个明显的缺点,就是三元不等式明明可以一行显示,非得格式化成3行,import用{}引入多个变量或者函数,非得格式化成好几行,看起来很是别扭.因此,好的格式化工具和团队代码风格一致,显得格外重要.我建议我们整个小组运用同一个编辑器,…
Web UI 设计命名规范 一.网站设计及基本框架结构: 1.    Container“container“ 就是将页面中的所有元素包在一起的部分,这部分还可以命名为: “wrapper“, “wrap“, “page“.2.    Header“header” 是网站页面的头部区域,一般来讲,它包含网站的logo和一些其他元素.这部分还可以命名为:“page-header” (或 pageHeader).3.    Navbar“navbar“等同于横向的导航栏,是最典型的网页元素.这部分还…
九.规范数据库设计 9-1.为什么要设计? 当数据库比较复杂时,我们就需要设计了! 糟糕的数据库设计: 数据冗余,浪费大量存储空间 使用物理外键,大量的增删改操作麻烦,异常 查询效率低下 良好的数据库设计: 节省内存空间 保证数据库的完整性 方便我们对于后台系统的开发 软件开发中,关于数据库的设计: 分析需求:分析业务和需要处理的数据库需求 概要设计:设计关系流程图 E-R图 ( 实体-联系图 : Entity Relationship Diagram ) 设计阶段: 收集信息,分析需求,建表…