精华内容
下载资源
问答
  • 代码规范

    千次阅读 2020-07-01 10:27:11
    代码规范(一) 说明:好的代码体现在很多方面,比如可读性,这个时候代码的一些格式就会有一些影响了。本文旨在记录一些好的代码格式,让人写出来的代码有一种美感。 以下摘自《阿里巴巴Java开发手册》,以后还会做...

    代码规范(一)

    说明:好的代码体现在很多方面,比如可读性,这个时候代码的一些格式就会有一些影响了。本文旨在记录一些好的代码格式,让人写出来的代码有一种美感。
    以下摘自《阿里巴巴Java开发手册》,以后还会做一些补充,先写这么多
    具体可以看原文,我现在只学习了这么多
    阿里巴巴Java开发手册

    一、大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行 ; 如果是非空代码块则:


    1.左大括号前不换行。
    2.左大括号后换行。
    3.右大括号前换行。
    4.右大括号后还有 else 等代码则不换行 ; 表示终止的右大括号后必须换行。

    举个例子:
    public class Student {
    	   private Integer age;
    	   private String name;
    
    	   public void setAge(Integer age) {
    	      this.age = age;
    	   }
    	   public Integer getAge() {
    	      System.out.println("Age : " + age );
    	      return age;
    	   }
    
    	   public void setName(String name) {
    	      this.name = name;
    	   }
    	   public String getName() {
    	      System.out.println("Name : " + name );
    	      return name;
    	   }
    
    	   public void printThrowException(){
    	       System.out.println("Exception raised");
    	       throw new IllegalArgumentException();
    	   }
    	}
    
    
    

    左括号不换行,右括号换行
    其实,我以前都是随便写的,喜欢把左大括号放单独一行~~~


    二、任何二目、三目运算符的左右两边都需要加一个空格。

    说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
    比如如下代码就很好

    a + b  
    a = b
    a && b
    
    这个就稍欠美感
    a+b
    a=b
    a&&b
    

    三、 左小括号和字符之间不出现空格 ; 同样,右小括号和字符之间也不出现空格。

    if (a + b)    正确
    if ( a + b )   错误
    

    暂时记录这么多吧,突然发现eclipse中有Format功能,这个ide也是足够强大了。Format是Ctrl + Shift + F
    注: Format功能可以自动按照代码规范来完善代码格式,强大嗷。


    不过,作者我觉得,Format功能固然是好,可是自己写的代码既是给自己看的也是给别人看的,自己的代码乱,估计也是在给以后的自己重构或者找bug挖坑吧。
    代码规范还是得注意一些。
    暂时就写这么些吧,以后用到了还会再补充的。

    展开全文
  • IDEA安装阿里代码规范插件

    万次阅读 多人点赞 2018-04-25 13:55:43
    所以下载阿里的代码规范插件来约束自己凌乱的代码。阿里规范插件GitHub地址:https://github.com/alibaba/p3cIDEA安装该插件步骤:1.打开IDEA,File-> Setteings->Plugins->Browse Repositorie...

    要养成一个好的编码习惯从自己编码开始,对自己代码的合理化命名,编码不仅对自己有好处,而且别人也容易读懂你的代码。

    所以下载阿里的代码规范插件来约束自己凌乱的代码。

    阿里规范插件GitHub地址:https://github.com/alibaba/p3c

    IDEA安装该插件步骤:

    1.打开IDEA,File-> Setteings->Plugins->Browse Repositories,在Browse Repositories搜索栏搜索Alibaba,然后安装

    2.安装完后点击       Restart IntelliJ IDEA

       3.之后去下载本地zip文件,下载地址:https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines

    选择自己喜欢的版本进行下载

    4.下载好了,打开IDEA,File->Settings->Plugin->Install plugin from disk,选择刚才自己下载插件zip包的地址,(最好存放的目录路径全英文,我不知道有中文路径是否会出错 哦),之后点击OK。之后回到主界面弹出重启的按钮,那就在重启一次吧。

    5.安装好了,使用方法是:打开IDEA,点击tools--->安装的阿里编码规约,可以选择中英文切换,项目右键选择编码规约扫描就可以进行查看自己编码哪些地方不够好,进行修改哦。

    6.我们也可以对检查约束进行选择哦,File->Settings->Editor->inspections,可以根据自己要求进行选择约束。

    7.如果存在中文乱码问题:

    可以Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成微软雅黑(microsoft yahei light)或者自己喜欢的其他字体哦。

    我的座右铭:不会,我可以学;落后,我可以追赶;跌倒,我可以站起来;我一定行。

     

    展开全文
  • Python PEP8 代码规范常见问题及解决方法

    万次阅读 多人点赞 2019-04-15 01:09:05
    之前一直用 Python IDLE 写代码,最近换成 PyCharm 写代码总是会出现波浪号,这才了解到 Python 的 PEP8 代码规范,所以将常见的 PEP8 代码规范问题和解决方法记录一下,学习一下,遇到了再持续更新,养成良好的习惯...

    之前一直用 Python IDLE 写代码,最近换成 PyCharm 写代码总是会出现波浪号,这才了解到 Python 的 PEP8 代码规范,所以将常见的 PEP8 代码规范问题和解决方法记录一下,学习一下,遇到了再持续更新,养成良好的习惯,编写规范的代码!


    • PEP 8: no newline at end of file
      解决方法:代码末尾需要另起一行,光标移到最后回车即可

    • PEP 8: indentation is not a multiple of four
      解决方法:缩进不是4的倍数,检查缩进

    • PEP 8: over-indented
      解决方法:过度缩进,检查缩进

    • PEP 8: missing whitespace after’,’
      解决方法:逗号后面少了空格,添加空格即可,类似还有分号或者冒号后面少了空格

    • PEP 8: multiple imports on one line
      解决方法:不要在一句 import 中引用多个库,举例:import socket, urllib.error最好写成:import socket import urllib.error

    • PEP 8: blank line at end of line
      解决方法:代码末尾行多了空格,删除空格即可

    • PEP 8: at least two spaces before inline comment
      解决方法:代码与注释之间至少要有两个空格

    • PEP 8: block comment should start with ‘#’
      解决方法:注释要以#加一个空格开始

    • PEP 8: inline comment should start with ‘#’
      解决方法:注释要以#加一个空格开始

    • PEP 8: module level import not at top of file
      解决方法:import不在文件的最上面,可能之前还有其它代码

    • PEP 8: expected 2 blank lines,found 0
      解决方法:需要两条空白行,添加两个空白行即可

    • PEP 8: function name should be lowercase
      解决方法:函数名改成小写即可

    • PEP 8: missing whitespace around operator
      解决方法:操作符(’=’、’>’、’<'等)前后缺少空格,加上即可

    • PEP 8: unexpected spaces around keyword / parameter equals
      解决方法:关键字/参数等号周围出现意外空格,去掉空格即可

    • PEP 8: multiple statements on one line (colon)
      解决方法:多行语句写到一行了,比如:if x == 2: print('OK')要分成两行写

    • PEP 8: line too long (82 > 79 characters)
      解决方法:超过了每行的最大长度限制79

    • PEP 8: Simplify chained comparison
      可简化连锁比较(例如:if a >= 0 and a <= 9: 可以简写为:if 0 <= a <= 9:


    如果想要选择性忽略PEP8代码风格的警告信息可以使用以下方法:(养成良好的习惯,编写规范的代码!不推荐忽略!)

    ①将鼠标移到出现警告信息的地方,按 alt+Enter,选择忽略(Ignore)这个错误即可:
    在这里插入图片描述
    ②依次选择 File - Settings - Editor - Inspections,在 Python下找到 PEP8 coding style violation 选项,在右下角的 Ignore errors 里点击加号可以添加需要忽略的警告信息ID(ID信息见后面附录),例如想要忽略indentation contains mixed spaces and tabs这个警告,只需要添加其ID:E101 即可
    在这里插入图片描述
    附录:全部警告信息以及对应的ID,官方地址:https://pep8.readthedocs.io/en/latest/intro.html#error-codes

    code sample message
    E1 Indentation
    E101 indentation contains mixed spaces and tabs
    E111 indentation is not a multiple of four
    E112 expected an indented block
    E113 unexpected indentation
    E114 indentation is not a multiple of four (comment)
    E115 expected an indented block (comment)
    E116 unexpected indentation (comment)
    E117 over-indented
    E121 (*^) continuation line under-indented for hanging indent
    E122 (^) continuation line missing indentation or outdented
    E123 (*) closing bracket does not match indentation of opening bracket’s line
    E124 (^) closing bracket does not match visual indentation
    E125 (^) continuation line with same indent as next logical line
    E126 (*^) continuation line over-indented for hanging indent
    E127 (^) continuation line over-indented for visual indent
    E128 (^) continuation line under-indented for visual indent
    E129 (^) visually indented line with same indent as next logical line
    E131 (^) continuation line unaligned for hanging indent
    E133 (*) closing bracket is missing indentation
    E2 Whitespace
    E201 whitespace after ‘(‘
    E202 whitespace before ‘)’
    E203 whitespace before ‘:’
    E211 whitespace before ‘(‘
    E221 multiple spaces before operator
    E222 multiple spaces after operator
    E223 tab before operator
    E224 tab after operator
    E225 missing whitespace around operator
    E226 (*) missing whitespace around arithmetic operator
    E227 missing whitespace around bitwise or shift operator
    E228 missing whitespace around modulo operator
    E231 missing whitespace after ‘,’, ‘;’, or ‘:’
    E241 (*) multiple spaces after ‘,’
    E242 (*) tab after ‘,’
    E251 unexpected spaces around keyword / parameter equals
    E261 at least two spaces before inline comment
    E262 inline comment should start with ‘# ‘
    E265 block comment should start with ‘# ‘
    E266 too many leading ‘#’ for block comment
    E271 multiple spaces after keyword
    E272 multiple spaces before keyword
    E273 tab after keyword
    E274 tab before keyword
    E275 missing whitespace after keyword
    E3 Blank line
    E301 expected 1 blank line, found 0
    E302 expected 2 blank lines, found 0
    E303 too many blank lines (3)
    E304 blank lines found after function decorator
    E305 expected 2 blank lines after end of function or class
    E306 expected 1 blank line before a nested definition
    E4 Import
    E401 multiple imports on one line
    E402 module level import not at top of file
    E5 Line length
    E501 (^) line too long (82 > 79 characters)
    E502 the backslash is redundant between brackets
    E7 Statement
    E701 multiple statements on one line (colon)
    E702 multiple statements on one line (semicolon)
    E703 statement ends with a semicolon
    E704 (*) multiple statements on one line (def)
    E711 (^) comparison to None should be ‘if cond is None:’
    E712 (^) comparison to True should be ‘if cond is True:’ or ‘if cond:’
    E713 test for membership should be ‘not in’
    E714 test for object identity should be ‘is not’
    E721 (^) do not compare types, use ‘isinstance()’
    E722 do not use bare except, specify exception instead
    E731 do not assign a lambda expression, use a def
    E741 do not use variables named ‘l’, ‘O’, or ‘I’
    E742 do not define classes named ‘l’, ‘O’, or ‘I’
    E743 do not define functions named ‘l’, ‘O’, or ‘I’
    E9 Runtime
    E901 SyntaxError or IndentationError
    E902 IOError
    W1 Indentation warning
    W191 indentation contains tabs
    W2 Whitespace warning
    W291 trailing whitespace
    W292 no newline at end of file
    W293 blank line contains whitespace
    W3 Blank line warning
    W391 blank line at end of file
    W5 Line break warning
    W503 (*) line break before binary operator
    W504 (*) line break after binary operator
    W505 (*^) doc line too long (82 > 79 characters)
    W6 Deprecation warning
    W601 .has_key() is deprecated, use ‘in’
    W602 deprecated form of raising exception
    W603 ‘<>’ is deprecated, use ‘!=’
    W604 backticks are deprecated, use ‘repr()’
    W605 invalid escape sequence ‘x’
    W606 ‘async’ and ‘await’ are reserved keywords starting with Python 3.7
    展开全文
  • JS代码规范

    万次阅读 2019-07-28 09:53:24
    这是我所在公司所定义的代码规范精简版的分享给大家做参考 如果感觉不错请分享给更多的朋友! 1、使用const,let代替var 2、使用字面量创建对象和数组 new Object() => {} New Array() => [] 3、使用对象...

    这是我所在公司所定义的代码规范精简版的分享给大家做参考

    如果感觉不错请分享给更多的朋友!

    1、使用const,let代替var

    2、使用字面量创建对象和数组
    new Object() => {}
    New Array() => []

    3、使用对象方法简写
    addValue: function() {} => addValue() {}

    4、使用对象属性值简写(简写属性在前,非简写属性在后)
    const obj = {data: data} => const obj = {data}

    5、通常情况下,对象的键不加引号,特殊情况如:
    {‘data-blah’: 5}

    7、不直接调用object方法
    obj.hasOwnProperty(key) => Object.prototype.hasOwnProperty.call(obj, key)
    str.toString() => String(str)

    8、 对象延展操作符复制对象和数组
    Object.assign({}, source, {a: 1}) => {…source, a: 1}
    Const itemsCopy = […items]

    9、 使用push为数组赋值
    Stack[stack.length] = ‘a’ => stack.push(‘a’)

    10、 推荐使用箭头函数,函数体为无副作用表达式,可省略返回值
    [1, 2, 3].map(x => x + 1)

    11、 使用解构表达式获取对象和数组中的数据
    const { firstName, lastName } = user
    const [first, second] = arr

    12、 String使用单引号字符串,React组件标签中使用双引号
    Var a = ‘hello’

    13、 使用模板拼接字符串
    'How are you, ’ + name + ‘?’ => How are you, ${name}?

    14、 使用命名函数表达式
    const short = function longUniqueMoreDescriptiveLexicalFoo() {};

    15、 不推荐修改函数参数或重新赋值
    function f1(obj) { obj.key = 1; }
    function f1(a) { a = 1; }

    17、使⽤class代替直接操作prototype
    class PeekableQueue extends Queue {
    constructor(…args) {
    super(…args);
    this.name = ‘Rey’;
    }
    }

    16、 避免使用一元增量量和递减
    num++ => num += 1

    17、 优先使⽤用 === 和 !== ⽽而不不是 == 和 !=

    18、 if 块执⾏了return 语句,不加else块
    function foo() {
    if (x) {
    return x;
    }
    return y;
    }

    19、 if中多个条件过长时使用换行
    if (
    (foo === 123 || bar === ‘abc’)
    && doesItLookGoodWhenItBecomesThatLong()
    && isThisReallyHappening()
    ) {
    thing1();
    }

    20、 不要使用选择操作符来代替控制语句
    !isRunning && startRunning() => if (!isRunning) {startRunning()}

    21、 使用两个空格缩进,空格隔开运算符,对象最后一行加逗号

    22、 转换字符串、数字
    this.reviewScore.toString() => String(this.reviewScore)
    Number(inputValue) parseInt(inputValue, 10)

    25、驼峰命名对象、数组、函数,使用帕斯卡式命名构造函数或类

    26、命名需具备描述性,不要使用下划线 _ 结尾或开头来命名属性和方法

    27、 若只输出一个类(导出默认函数),文件名与类名保持一致
    export default makeStyleGuide js文件名:makeStyleGuide

    展开全文
  • Shell代码规范

    万次阅读 2014-01-29 15:53:07
    Shell代码规范 作 者: 毕小朋 用 途: 规范Shell代码书写,方便查看与修改 博 客: http://blog.csdn.net/wirelessqa 参 考: http://www.ohlinux.com/archives/191/ http://kodango.com/shell-script-style 关于...
  • 代码规范利器-阿里代码规范插件

    千次阅读 2020-06-20 23:36:42
    好的代码规范不管对自己还是对别人都很重要,毕竟大家都不想接手到各种难以读懂的代码。 今天跟大家介绍一下阿里代码规范插件的安装使用以及注意事项。 首先需要在线安装插件到Idea,可以直接在File-> ...
  • VUE代码注释规范,代码规范

    千次阅读 2019-08-15 10:52:09
    VUE代码注释规范,代码规范 背景 其实关于这一点我是深恶痛绝呀,你说我们吧eslint开了,来敲代码,就能把你的代码给规范了吧,关于组件命名和src结构都是按照VUE目录给的(项目成员已构造),功能注释和调试代码...
  • Python代码规范和命名规范

    万次阅读 多人点赞 2017-10-26 14:40:47
    Python代码规范和命名规范 前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯 目录 一、简明概述 1、编码 如无特殊情况, 文件一律使用 UTF-
  • Java代码规范

    万次阅读 多人点赞 2018-01-10 10:06:02
    Java代码规范 本Java代码规范以SUN的标准Java代码规范为基础,为适应我们公司的实际需要,可能会做一些修改。本文档中没有说明的地方,请参看SUN Java标准代码规范。如果两边有冲突,以本文档为准。 1. ...
  • python代码规范

    千次阅读 多人点赞 2018-08-16 02:59:29
    为什么要有代码规范? 1.做哪一行都有高低级别之分,别写一行代码就被人鄙视了 2.好的规范会形成好的编码风格,看着熟悉、亲切,心情好 3.增加可读性,易维护,提高工作效率 4.遵循规范,代码会自己写代码 5....
  • JavaScript 代码规范

    千次阅读 2018-05-29 06:23:42
    JavaScript 代码规范 代码规范通常包括以下几个方面: 变量和函数的命名规则 空格,缩进,注释的使用规则。 其他常用规范…… 规范的代码可以更易于阅读与维护。 代码规范一般在开发前规定,可以跟你的团队成员...
  • C# 代码规范

    千次阅读 2019-07-04 14:25:08
    代码规范主要从命名规范、布局规范、注释规范、代码使用规范四块来解释。 命令规范 变量命名规范 1). 含义,变量一般指局部变量、成员变量、全局变量以及方法中的参数,这些命名要具有 相对应的含义,一般使用...
  • 工作中的代码规范

    万次阅读 2020-09-15 22:56:47
    不同的公司可能代码规范不一样,如果你的领导没有特殊要求,规范都是一些常用的google等一些常见规范格式,可以用clang-format-3.6命令来格式化代码,代码提交前一定要注意格式,代码的美感也是很重要的。...
  • 前端代码规范

    2016-10-17 14:31:45
    前端代码规范化书写,可增加代码可读性,代码可维护性。ecomfe推出的前端代码规范,符合js标准,规定了js、css、html、less等前端代码的规范书写。是个不错的规范。
  • 规范-阿里代码规范设置

    万次阅读 2018-03-07 23:21:47
    阿里代码规范设置1. 阿里代码规范地址https://github.com/alibaba/p3c2. 安装eclipse规范文件2.1. 导入代码格式文件https://github.com/alibaba/p3c/tree/master/p3c-formatter2.2. 导入代码格式化样式3. 安装...
  • 嵌入式C语言代码规范

    万次阅读 2019-12-17 16:26:27
    C语言代码规范 参考安富莱C语言编码规范 1.文件与目录 1、文件及目录的命名规定可用的字符集是[A-Z;a-z;0-9;._-]。 2、源文件名后缀用小写字母 .c 和.h。 3、文件的命名要准确清晰地表达其内容,同时文件名应该...
  • C#代码规范

    千次阅读 2015-11-12 10:24:41
    C#命名规范C#代码规范 1.注释写在上面,充分利用C#的提示 2.短路写法,把大量的前提预先处理,可以让代码实现逻辑更清晰,并能有效的所见代码嵌套深度 3.要常用自带的Action Func Predicate委托类型 不要引入...
  • java代码规范

    千次阅读 2019-04-22 15:19:10
    大的角度来说,代码规范是一种本行业约定俗称、默认遵从的普遍规则,但是除此之外,根据各公司不同甚至各人习惯不同,又会在原有规则上进行一些变通,以下规范两者兼有,大家可以择优而取。 1. 标识符命名规范 1.1 ...
  • Google 代码规范

    千次阅读 2017-06-13 14:49:08
    Google 定义的代码规范 包括文件名,棉麻格式,文件节后等
  • 代码规范的好处

    千次阅读 2020-01-17 16:42:53
    代码规范化的第一个好处就是看着很整齐、很舒服。假如你现在用不规范的方式写了一万行代码,现在能看得懂,但等过了三个月你再回头看时就很吃力了,更不要说给别人看了。所以代码要写规范,比如加注释就是代码规范化...
  • C语言代码规范(编程规范)

    千次阅读 多人点赞 2018-11-24 20:45:49
    C语言代码规范(编程规范) 什么叫规范?在C语言中不遵守编译器的规定,编译器在编译时就会报错,这个规定叫作规则。但是有一种规定,它是一种人为的、约定成俗的,即使不按照那种规定也不会出错,这种规定就叫作...
  • 用VsCode写Python,代码提示代码规范方法

    万次阅读 多人点赞 2017-05-04 15:56:19
    在使用Python 开发的时候,一款好的编辑器简直可以提高代码效率以及质量好几倍。而Vs Code 就是一个不错的选择。你值得拥有。 而且还支持markdown,其他各种各样的语言当然,最主要的还是好看效果图: VScode...
  • Python 代码规范

    千次阅读 多人点赞 2017-06-13 00:44:49
    前言Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯目录一、简明概述1、编码 如无特殊情况, 文件一律使用 UTF-8 编码 如无特殊情况, 文件头部必须加入#-*-coding:...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 86,041
精华内容 34,416
关键字:

代码规范