编码规范学习总结

164173422 陶冶

GitHub 地址

https://github.com/fishmanIs

自己的错误

  • 错误1:毫无意义的命名

    案例:

  • 错误2:命名抽象不合理

    案例:

  • 错误3:命名格式不规范

    案例:第一张未使用WinForm Control 命名规范,第二张私有变量命名格式错误

  • 错误4:卖弄风骚(大概算是

    案例:

  • 错误5:注释多余、没解释清楚

    案例:

  • 错误6:注释代码

    案例:

施金鑫的错误

  • 错误1:毫无意义的命名

    案例:

  • 错误2:命名不合理,难以理解

    案例:第一张图中的count,第二张图的事件名

  • 错误3:继承了Account,命名没有以Account为结尾

    案例:

  • 错误4:歧义

    案例:CreditLine信用额度应该是正数

  • 错误5:注释代码

    案例:

  • 错误6:排版不规范

    案例:第一张花括号没对齐,第二张方法之间无空行

袁敏智的错误

  • 错误1:命名不规范,没用camelCasing

    案例:

  • 错误2:毫无意义的命名

    案例:

  • 错误3:继承了Account,命名没有以Account为结尾

    案例:

  • 错误4:突如其来的骚

    案例:

  • 错误5:注释代码

    案例:

  • 错误6:多余注释

    案例:

  • 错误7:超长方法

    案例:

感悟

英语不好起名字真的累,各种找翻译。不过名字起的好看着方便。

自己的代码惯性写注释,不必要的注释很多得改改习惯。名字起好可以省一堆注释了。

排版规范对强迫症十分友好,点赞。

学习时间统计

  • 计划学习时间:17小时
  • 实际学习时间:18小时

参考资料

原文地址:https://www.cnblogs.com/taoyemzbyl/p/8443249.html

时间: 2024-08-29 02:54:10

编码规范学习总结的相关文章

阿里编码规范学习

针对附录中的阿里编码规范,直接指定标题位置,或列出相应规范内容,与其说是编码规范,不如说是新手防坑指南,菜鸟们很值得一看. 一编码规范 (一)命名规约 6.[强制]抽象类命名使用 Abstract 或 Base 开头:异常类命名使用 Exception 结尾:测试类 命名以它要测试的类的名称开始,以 Test 结尾. 7.[强制]中括号是数组类型的一部分,数组定义如下:String[] args; 个人理解:禁止使用String args[].同时数组创建又分为动态创建和静态创建, 静态:int

Javascript编码规范学习

http://javascript.crockford.com/code.html文章学习笔记. 1.使用js文件管理代码 所有代码尽量放在js文件中,然后再html文件中使用script引入,引入时注意放在body标签后面,并且不使用type或者language. 2.书写缩进 使用4个空白格缩进,注意不要使用tab键进行缩进. 3.断句 注意行长,每行不超过80个字符,超过时要进行适当断句,断句应该再操作符后面进行,最理想的是在逗号(,)后面进行断句,断句后下一行使用8格缩进. 4.注解 一

Python编码规范学习

Python 风格规范(Google) 本项目并非 Google 官方项目, 而是由国内程序员凭热情创建和维护. 如果你关注的是 Google 官方英文版, 请移步 Google Style Guide 以下代码中 Yes 表示推荐,No 表示不推荐. 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行. 行长度 每行不超过80个字符 以下情况除外: 长的导入模块语句 注释里的URL 不要使用反斜杠连接行. Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这

《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:

<从零开始学Swift>学习笔记(Day 57)--Swift编码规范之注释规范:文件注释.文档注释.代码注释.使用地标注释 原创文章,欢迎转载.转载请注明:关东升的博客 前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 文件注释 文件注释就在每一个文件开头添加注释,文件注释通常包括如下信息:版权信息.文件名.所在模块.作者信息.历史版本信息.文件内容和作用等. 下面看一个文件注释的示例: /* Copyright (C) 201

学习一份百度的JavaScript编码规范

JavaScript编码规范 1 前言 2 代码风格 2.1 文件 2.2 结构 2.2.1 缩进 2.2.2 空格 2.2.3 换行 2.2.4 语句 2.3 命名 2.4 注释 2.4.1 单行注释 2.4.2 多行注释 2.4.3 文档化注释 2.4.4 类型定义 2.4.5 文件注释 2.4.6 命名空间注释 2.4.7 类注释 2.4.8 函数/方法注释 2.4.9 事件注释 2.4.10 常量注释 2.4.11 复杂类型注释 2.4.12 AMD 模块注释 2.4.13 细节注释 3

PHP编码规范建议学习

###php编码规范 -------* sql过长 ```$sql = <<<SQLSELECT delivery_idFROM d_testWHERE delivery_idIN (123,234)GROUP BY delivery_idHAVING SUM(send_number) <= 0;SQL;```* if等控制结构条件过长 ```if ($a > 0 && $b > 0 && $c > 0 && $d

PHP 高级程序设计(1) - 编码规范及文档编写

PHP 高级程序设计学习笔记20140612 软件开发中的一个重要环节就是文档编写.他可以帮助未来的程序维护人员和使用者理解你在开发时的思路.也便于日后重新查看代码时不至于无从下手.文档还有一个重要的作用,在不用了解要访问对象的细节情况下也能很好的在对象之间进行交互.文档的编写有一些成熟的行业标准格式,遵守这些行业标准将有助于创建易于阅读的代表,并使自动生成手册成为可能. 编码规范 编码规范可能很多开发人员都有各自的观点也意见,且大家不尽相同.其实只要团队成员之间达成一致,遵循同一个标准就好.

《疯狂Java讲义(第3版)》.(李刚)——java命名规则及编码规范

1.命名规则: 此处借鉴一下他人的资料,比较全面一些,方便了解学习. JAVA源文件的命名 JAVA源文件名必须和源文件中所定义的类的类名相同. Package的命名 Package名的第一部分应是小写ASCII字符,并且是顶级域名之一,通常是com.edu.gov.mil.net.org或由ISO标准3166.1981定义的国家唯一标志码.Package名的后续部分由各组织内部命名规则决定,内部命名规则指定了各组件的目录名,所属部门名.项目名等. Class/Interface的命名 Clas

Objective-C编码规范[译]

原文链接 : The official raywenderlich.com Objective-C style guide 原文作者 : raywenderlich.com Team 译文出自 : raywenderlich.com Objective-C编码规范 译者 : Sam Lau 因为我正在准备模仿饿了么这个app,到时可能有些iOS开发人员參与进来. 这时假设每一个人的Objective-C编码风格都不一样,这样不易于保持代码一致性和难以Code Review.所以我在网上搜索到 T