美文网首页
代码规范

代码规范

作者: luxidia | 来源:发表于2021-05-05 14:00 被阅读0次

妈妈再也不用担心我的代码把自己丑哭了。
这篇主要讲基本语法中的代码格式规范。
变量命名规范请移步编程命名规范 - 简书 (jianshu.com)

代码规范化的七大原则

1、空行

规则一:
定义变量后要空行

int a;

规则二:
每个函数定义结束之后都要加空行、

function pri;

2、空格

规则一:
关键字之后要留空格

while  (a == 0){
}

规则二:
函数名之后不要留空格,应紧跟左括号

pri()

规则三:
向后紧跟。
, ;这三个向前紧跟,紧跟处不留空格。

for (i = 0; i < a.len; i++){
    print("a=", a.num[i]);
}

规则四:
, 后面要留空格
; 若不在一行结尾处,后面要留空格
样例见规则三
规则五:
双目运算符(赋值、关系、算数、逻辑、位运算符)前后应加空格

a + b == c
x = 1

规则六:
单目运算符前后不加空格

if(!a)
b++;

规则七:
对于表达式比较长的 for 语句和 if 语句,为了紧凑可以适当去掉一些空格

3、成对书写

括号、引号等成对出现的符号书写时成对书写,再往里填充内容。

for ()
for (i = 0; i < a; i++)
if ()
if (a < 0)

if (a < 0){
}

if (a < 0){
    a = b;
}

print()
print("")
print("Hello, world!")

5、缩进

基本上按照python那套缩进规则来就行。
一般情况下,顺序结构不缩进,函数、条件、循环内部代码块缩进。
缩进最好使用4个空格而不是Tab。
Tab是制表符,通常情况下,一个Tab的尺寸等于四个空格。但在不同的编辑器里,Tab尺寸会有区别。特别的,在使用python语言的时候,使用Tab缩进会造成编译错误。

6、代码行

规则一:
一行代码只做一件事情,如只定义一个变量,或只写一条语句。
这里的一件事情个人理解为,一个分号 ; 结束的语句。

int a;
int b1, b2;
a = 1;

规则二:
大括号{}内的代码要向内缩进一个Tab(4个空格),且同一地位的左对其,不同地位的继续缩进。

while (a > 0){
    b = 0;
    if  (c > 0){
        b = b + c;
    }
    a++;
}

7、注释

规则一:注释是对代码的提示而不是文档。
规则二:如果代码本来就是清楚的,则不必加注释。

参考来源:https://www.zhihu.com/question/278511114/answer/1317817479

相关文章

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • iOS 代码规范篇

    iOS 代码规范篇 iOS 代码规范篇

  • iOS(OC)开发之随感

    1.代码规范 规范很重要!规范很重要!规范很重要! 代码规范的重要性之-为什么谷歌要执行严格的代码编写规范http...

  • 前端学习的基本总结

    目录 1.为什要遵守代码规范 2.css代码规范 3.js代码规范与设计模式3.1 js代码规范3.2 设计模式 ...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • PSR-2- Coding Style Guide 编码风格规范

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则,...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

网友评论

      本文标题:代码规范

      本文链接:https://www.haomeiwen.com/subject/fmpkdltx.html