您当前的位置:首页 > 电脑百科 > 程序开发 > 编程百科

TypeScript编码指南

时间:2019-10-12 09:36:09  来源:  作者:
基础秘籍之TypeScript编码指南

编码指南

命名

  1. 使用 PascalCase 方式对类进行命名.
  2. 接口命名中不要使用前缀字母 I .
  3. 使用 PascalCase 方式对枚举值进行命名.
  4. 使用 camelCase 方式对函数进行命名.
  5. 使用 camelCase 方式对属性和本地变量进行命名.
  6. 私有属性命名不要使用前缀 _ .
  7. 尽可能在命名中使用整个单词 .

组件

  1. 每个逻辑组件一个文件 (例如: parser, scanner, emitter, checker).
  2. 不要添加新文件. :)
  3. 带有".generated.*"后缀的文件是自动生成的,不要手动去修改.

类型

  1. 除非您需要跨多个组件共享,否则不要导出类型/函数.
  2. 不要向全局命名空间引入新类型/值.
  3. 共享类型应在 types.ts 中定义.
  4. 在文件中,应首先输入类型定义.

null 和 undefined

  1. 使用 undefined , 不要使用 null .

一般假设

  1. 将节点,符号等对象视为创建它们的组件之外的不可变对象。 不要改变它们。
  2. 创建后,默认情况下将数组视为不可变.

  1. 为保持一致性,请不要在核心编译器管道中使用类。 请改用函数闭包.

标志

  1. 应该将类型上超过2个相关的布尔属性转换为标志。

注释

  1. 对函数,接口,枚举和类使用JSDoc样式注释。

字符串

  1. 使用双引号.
  2. 用户可见的所有字符串都需要进行本地化(在diagnosticMessages.json中创建一个条目)。

诊断信息

  1. 在句子末尾使用句号.
  2. 对不确定的实体使用不定的文章.
  3. 应该命名确定的实体(这是为变量名,类型名等等。).
  4. 在陈述规则时,主题应该是单数的 (e.g. "An external module cannot..." instead of "External modules cannot...").
  5. 使用现在时.

诊断消息代码

诊断分为一般范围。 如果添加新的诊断消息,请使用大于相应范围中最后使用的数字的第一个整数。

  • 1000 句法消息的范围
  • 2000 用于语义消息
  • 4000 用于声明发出消息
  • 5000 用于编译器选项消息
  • 6000 用于命令行编译器消息
  • 7000 对于noImplicitAny消息

一般构造

出于各种原因,我们避免某些结构,并使用我们自己的一些结构。 其中:

  1. 不要使用 for..in 语句; 相反,使用 ts.forEach , ts.forEachKey 和 ts.forEachValue 。 请注意它们的语义略有不同。
  2. 当它不是非常不方便时,尝试使用 ts.forEach , ts.map 和 ts.filter 而不是循环。

风格

  1. 使用箭头函数而不是匿名函数。必要时仅限制环绕箭头功能参数。例如, (x)=> x + x 错误,但以下是正确的:
  2. x => x + x
  3. (x,y) => x + y
  4. <T>(x: T, y: T) => x === y
  5. 始终用花括号环绕循环和条件体。 允许在同一行上的语句省略大括号.
  6. 开放的花括号总是与任何必要条件都在同一条线上.
  7. 带括号的构造应该没有周围的空格。单个空格在这些构造中使用逗号,冒号和分号。 例如:
  8. for (var i = 0, n = str.length; i < 10; i++) { }
  9. if (x < 10) { }
  10. function f(x: number, y: string): void { }
  11. 每个变量语句使用一个声明
  12. (i.e. 使用var x = 1; var y = 2; 而不是 var x = 1, y = 2;).
  13. else 与闭合的大括号分开.
  14. 每个缩进使用4个空格.

原文地址: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines

总结

在实际开发过程中,可能有些编码风格和文中的有不同,但只要风格统一就好。不要不同的风格混搭使用。

比如:

  1. 字符串不要一会使用单引号,一会使用双引号
  2. 缩进有的文件使用2个空格,有的文件使用4个


Tags:TypeScript   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
本文最初发表于 Towards Data Science 博客,经原作者 Rhea Moutafis 授权,InfoQ 中文站翻译并分享。Python 是我的谋生工具,我很喜欢它。尽管我对这门语言有一些批评的地方,但我...【详细内容】
2020-10-30  Tags: TypeScript  点击:(90)  评论:(0)  加入收藏
作者:子弈转发链接:https://juejin.im/post/6856410900577026061目录从零开始配置 TypeScript 项目的教程(一)从零开始配置 TypeScript 项目的教程(二) 本篇Jest 确保构建单独通...【详细内容】
2020-08-20  Tags: TypeScript  点击:(54)  评论:(0)  加入收藏
命令行:npm install -g typescript 新建一个TypeScript文件,粘贴如下内容:function greeter(person) { return "Hello, " + person;}var user = "Jane User";document.bod...【详细内容】
2020-08-20  Tags: TypeScript  点击:(132)  评论:(0)  加入收藏
作者:神奇的程序员K转发链接:https://mp.weixin.qq.com/s/3B8dZRfbIuktSBeArXlmcQ前言我们在页面上渲染数据时,通常会根据特定规则来对数据进行一个排序,然后再将其渲染到页面...【详细内容】
2020-08-17  Tags: TypeScript  点击:(85)  评论:(0)  加入收藏
一、什么是 TypeScriptTypeScript 是近几年被火爆的应用了,这让大家产生了一个错觉:这么多的拥护者,难道TypeScript是一个新的语言?TypeScript是微软公司开发和维护的一种面向对...【详细内容】
2020-08-05  Tags: TypeScript  点击:(70)  评论:(0)  加入收藏
相信这段时间来,对 TypeScript 感兴趣的小伙伴们已经把这个神器给系统的学习了一遍了吧。如果计划开始学习但是还没有开始,或者没有找到资料的同学,可以看下我在之前文章中 前端进阶指南[1] 找一下 TypeScript 部分的教...【详细内容】
2020-06-11  Tags: TypeScript  点击:(49)  评论:(0)  加入收藏
很多开发者对新生事物,会有畏惧的心情,其实,静下心来,大家会发现,编程语言之间都是相通的,大同小异。因最近Cocos游戏开发建议使用TypeScript,故给大家介绍下TypeScript,帮助大家快...【详细内容】
2019-11-14  Tags: TypeScript  点击:(79)  评论:(0)  加入收藏
编码指南命名 使用 PascalCase 方式对类进行命名. 接口命名中不要使用前缀字母 I . 使用 PascalCase 方式对枚举值进行命名. 使用 camelCase 方式对函数进行命名. 使用 came...【详细内容】
2019-10-12  Tags: TypeScript  点击:(160)  评论:(0)  加入收藏
JavaScript:基本概念:JavaScript一种直译式脚本语言,是一种动态类型、弱类型、基于原型的语言,内置支持类型。它的解释器被称为JavaScript引擎,为浏览器的一部分,广泛用于浏览...【详细内容】
2019-06-18  Tags: TypeScript  点击:(399)  评论:(0)  加入收藏
▌简易百科推荐
本文分为三个等级自顶向下地分析了glibc中内存分配与回收的过程。本文不过度关注细节,因此只是分别从arena层次、bin层次、chunk层次进行图解,而不涉及有关指针的具体操作。前...【详细内容】
2021-12-28  linux技术栈    Tags:glibc   点击:(3)  评论:(0)  加入收藏
摘 要 (OF作品展示)OF之前介绍了用python实现数据可视化、数据分析及一些小项目,但基本都是后端的知识。想要做一个好看的可视化大屏,我们还要学一些前端的知识(vue),网上有很多比...【详细内容】
2021-12-27  项目与数据管理    Tags:Vue   点击:(2)  评论:(0)  加入收藏
程序是如何被执行的&emsp;&emsp;程序是如何被执行的?许多开发者可能也没法回答这个问题,大多数人更注重的是如何编写程序,却不会太注意编写好的程序是如何被运行,这并不是一个好...【详细内容】
2021-12-23  IT学习日记    Tags:程序   点击:(9)  评论:(0)  加入收藏
阅读收获✔️1. 了解单点登录实现原理✔️2. 掌握快速使用xxl-sso接入单点登录功能一、早期的多系统登录解决方案 单系统登录解决方案的核心是cookie,cookie携带会话id在浏览器...【详细内容】
2021-12-23  程序yuan    Tags:单点登录(   点击:(8)  评论:(0)  加入收藏
下载Eclipse RCP IDE如果你电脑上还没有安装Eclipse,那么请到这里下载对应版本的软件进行安装。具体的安装步骤就不在这赘述了。创建第一个标准Eclipse RCP应用(总共分为六步)1...【详细内容】
2021-12-22  阿福ChrisYuan    Tags:RCP应用   点击:(7)  评论:(0)  加入收藏
今天想简单聊一聊 Token 的 Value Capture,就是币的价值问题。首先说明啊,这个话题包含的内容非常之光,Token 的经济学设计也可以包含诸多问题,所以几乎不可能把这个问题说的清...【详细内容】
2021-12-21  唐少华TSH    Tags:Token   点击:(10)  评论:(0)  加入收藏
实现效果:假如有10条数据,分组展示,默认在当前页面展示4个,点击换一批,从第5个开始继续展示,到最后一组,再重新返回到第一组 data() { return { qList: [], //处理后...【详细内容】
2021-12-17  Mason程    Tags:VUE   点击:(14)  评论:(0)  加入收藏
什么是性能调优?(what) 为什么需要性能调优?(why) 什么时候需要性能调优?(when) 什么地方需要性能调优?(where) 什么时候来进行性能调优?(who) 怎么样进行性能调优?(How) 硬件配...【详细内容】
2021-12-16  软件测试小p    Tags:性能调优   点击:(20)  评论:(0)  加入收藏
Tasker 是一款适用于 Android 设备的高级自动化应用,它可以通过脚本让重复性的操作自动运行,提高效率。 不知道从哪里听说的抖音 app 会导致 OLED 屏幕烧屏。于是就现学现卖,自...【详细内容】
2021-12-15  ITBang    Tags:抖音防烧屏   点击:(25)  评论:(0)  加入收藏
11 月 23 日,Rust Moderation Team(审核团队)在 GitHub 上发布了辞职公告,即刻生效。根据公告,审核团队集体辞职是为了抗议 Rust 核心团队(Core team)在执行社区行为准则和标准上...【详细内容】
2021-12-15  InfoQ    Tags:Rust   点击:(25)  评论:(0)  加入收藏
最新更新
栏目热门
栏目头条