本文作者:IMWeb 我饿了 原文出处:IMWeb社区 未经同意,禁止转载 在学习编程的时候,每次看到那些整齐规范的代码,心里顿时对这个程序员表示点点好感,有时,比如看到自己和朋友写的代码时, 那阅读起来就是苦不堪言,所以,一些基本的开发规范是必须的,是为了自己方便阅读代码,也方便他人阅读修改代码。 canRead() { return true; } //获取姓名 function getName { return this.name; } ---- 常量 命名方法:全部大写 命名规范 文档规范 HTML5的文档类型声明:<! 'valid' : 'invalid' ---- JSHint 在js规范中,有很多规范都是样式上的规范而不是逻辑上的规范,比如尽量使用=== 而不是==,我们可以使用JSHint或者JSLint,Javascript
建议统一异常处理,不仅要在日志中打印异常堆栈信息,还得给前端统一格式的响应信息,而不是前端页面直接提示给用户500
原文链接:从零开始搭建android框架系列 前言 在开发中,一个良好的开发习惯以及一个开发规范可能会让你少走很多弯路,也会一定程度上的提高代码的可读性,可维护性和可拓展性。 你会明白一个好的开发规范多么多么的重要。 这里整理一下自己android开发中的一些规范。希望对各位有帮助。 ---- 命名规范 包命名规范 包名全部采用小写 主包名采用[公司性质]. 代码命名规范 命名规则有很多高大上的名词,比如大驼峰,小驼峰,匈牙利命名法。其实最简单的就是按照谷歌命名学习。 常量、枚举等均采用大写形式,用下划线区分各单词。 更多命名规范 之前收藏的这篇文章比较全。Android 命名规范 (提高代码可以读性) ---- 编程规范 源文件编码格式为 UTF-8。 我们使用的无论是git,还是svn都需要遵守下面这些规范,个人比较倾向于git。
, 比如ad_left01.gif || btn_submit.gif; 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间; 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明 760X100,750X120,468X60,468X95,728X90,585X140 次级页的pip尺寸360X300,336X280 游标:100X100或120X120 LOGO的国际标准规范
该规范主要参考《谷歌的代码评审指南》 ? commit 的详细描述,可以分成多行 footer 部分只用于两种情况:1、不兼容变动;2、关闭issue 扩展:如果你使用 IDEA 进行编码,可以是使用 git commit template 插件来规范每次提交的 风格:代码是否遵循了代码开发规范 文档:开发人员是否也同步更新了相关文档 在评论前加上“nit:”这样的前缀,表明这是一个优化性的建议,可以不影响本次上线 应在一个工作日内完成评审,并给出意见 评价只针对代码和具体业务流程
Coding ◆ 规范 ◆ 一个前端项目,目录的规范是必要的,当然,在一般开发中是没有必要做的那么严谨,在此,分享一下个人认为的基础规范,都只是个人认为。 项目目录规范 ? (本人还不够好,所以几乎没有) JavaScript规范 JS的规范就很多了,各个大公司的规范也不尽相同,由于水平有限,在我的理解就是,一个项目的规范主要就是约定好代码的风格。 在此罗列一些基础的JavaScript代码规范: 缩进:统一缩进,一个项目要码四个空格一个tab,要码两个空格一个tab; 空格:二元运算符左右空格,一元运算符不允许有空格,var a = b; a (a, b, c){}; 分号:函数定义结束不加分号,其他都加分号function(){} for(){}; 命名:都已驼峰法命名(有人建议常量都大写然后下划线隔开,类首字母大写) 注释:注释规范有单行 、多行、文件注释、命名空间注释等等等等,水平有限,还未实践,可自行百度; 字符串:因为JS的特性,建议都用单引号 var str = 'aaa'; JavaScript规范的东西太多,
,它的作者就是AMD规范的创始人 James Burke。 因为像 requireJS 其并不是只是纯粹的AMD固有思想,其也是有CMD规范的思想,只不过是推荐 AMD规范方式而已, seaJS也是一样。 类似的还有 CommonJS Modules/2.0 规范,是 BravoJS 在推广过程中对模块定义的规范化产出还有不少?? 这些规范的目的都是为了 JavaScript 的模块化开发,特别是在浏览器端的。 目前这些规范的实现都能达成浏览器端模块化开发的目的。 区别: 1. 还有一些细节差异,具体看这个规范的定义就好,就不多说了。
文件命名一律采用小写,不用驼峰式,尽量见名思义,看见文件名就可以知道这个文件下的大概内容。 其中测试文件以test.go结尾,除测试文件外,命名不出现。
前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯 目录 一、简明概述 1、编码 如无特殊情况, 文件一律使用 UTF 'blah': do_blah_thing() # 不推荐的写法 if foo == 'blah': do_blash_thing() 6、docstring docstring 的规范中最其本的两点 """ 文档注释不限于中英文, 但不要中英文混用 文档注释不是越长越好, 通常一两句话能把情况说清楚即可 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释 三、命名规范
代码段必须使用 Fenced code blocks 风格 参考文章 写作规范和格式规范—Daocloud Markdown 写作规范—Google Markdown style guide—Baidu
如何规范你的Git commit? 约定式提交 1.0.0
1、模块 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况) # 正确的模块名 import decoder import html_parser # 不推荐的模块名 import Decoder 2、类名 类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头 class Farm(): pass class AnimalFarm(Farm): pass class _PrivateFarm(Farm): pa
经过测试才能合入当前的main分支 EMR-release-20220218:开发/测试分支; 命名规则: 模块名称-release - 提测时间戳 注意: 目前前端工程目前已经开启了eslint,并参照我们的前端代码规范进行相关的 后期将打开服务端校验,所以在下面一个周期内,每个工程对应的前端负责人,务必清除掉全部的eslint的问题 git commit --no-verify -m "提交注释" //可以跳过代码检查 代码提交规范
其实除了这些大公司,软件公司都最好有自己的GUI设计规范,即使这个规范简略一些,也可以帮助团队改善工作、提高工作效率及传递品牌价值。 2. 公司用设计规范体现公司的设计品味和企业价值;设计人员和开发人员通过设计规范协助自己的工作,测试人员以设计规范作为UI验收的标准;对营销部门设计规范也是重要的参考资料。 5. 6.5 其它 很多设计规范还把动效和交互单独说明,可能由于这是比较深入的内容或者难于在PDF上展示,所以也有不少设计规范没有这些内容。设计自己团队的设计规范时可以把这些内容留到最后。 7. 设计规范一旦落伍就容易不被认同,渐渐地就没人看,没人执行,最后设计规范将变得毫无意义。所以设计规范应该持续改进,以使得基于设计规范的工作不断得到改善。 8. 8.5 案例 设计规范最好有已成功的案例,这才是对设计规范最好的展示。 9. 设计规范网站分享 以Button为例,比较一下各大公司的GUI设计规范 Apple ? Google ?
【强制】杜绝完全不规范的缩写,避免望文不知义。反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。
现大框架已经完成,正在进行细节模块上的开发 抽空总结一下Android项目的开发规范:1、编码规范 2、命名规范 注:个人经验,经供参考 --------------------------- ---------------------------------------------------------------------------------------- 一、Android编码规范 所以所有的Activity都要设定一个统一的规范。 规范做法: ViewHolder一个类 ,Adapter一个类 , 分工明确 ,避免一个类中代码量过多的问题。 命名规范:驼峰法,下划线分割法。
规范 切忌一次大量提交代码,每次 fix 或 feat 一个功能即需要提交到本地,可以不提交到远程 提交代码前必须先拉代码 一般情况下 因此,为了解决这些问题,我们希望通过一种方式来监控用户的 git commit message,以提高代码规范,提高开发效率。 我们将这个规范作为 git hook 的 commit-msg 和 pre-receive 执行,不符合规范的 commit 无法提交。 注意:feat 改成 func 了,避免大家按 feature 这个大粒度来提交,期望是按小功能点分批提交,另外避免跟 feature 分支规范混淆。 首发博客地址: https://blog.zysicyj.top/ [2] 系列文章地址: https://blog.zysicyj.top/categories/技术文章/后端技术/系列文章/开发规范
(一)命名规范 1.1.1 项目命名 全部采用小写方式,以中划线分隔。 (一) Vue 编码基础 vue 项目规范以 Vue 官方规范(https://cn.vuejs.org/v2/style-guide/)[3] 中的 A 规范为基础,在其上面进行项目开发,故所有代码均遵守该规范 请仔细阅读 Vue 官方规范,切记,此为第一步。 2.1.1 组件规范 1) 组件名为多个单词。 组件名应该始终由多个单词组成,且命名规范为KebabCase格式。 path、childrenPoints 命名规范采用kebab-case命名规范(尽量保持 vue 文件的目录结构一致,因为目录和文件名都是kebab-case,这样很方便找到对应的文件) name 命名规范采用KebabCase命名规范且与 component 组件名保持一致!
static 静态方法,只能console.log(Test.getFormatName())
背景:如何更规范化编写Java 代码的重要性想必毋需多言,其中最重要的几点当属提高代码性能、使代码远离Bug、令代码更优雅。