`

形成自己的一套代码书写规范

阅读更多

刚开始写代码的时候,感觉只要是把功能完成也就可以了。

但是,最近接触的多了,就感到代码书写的规范性的必要了,不止是使代码看起来更加整齐,使人感到舒服,还有就是要使自己以及他人能够通过我们自己的命名,来知晓某一段函数所实现的功能。所以,我在网上找了一些比较适合自己,也比较常见的命名方式,来时刻提醒自己代码的规范性。

类的命名   
  
   类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。     
  例如: Circle   
  
方法的命名   
  
  方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。  
  例如: sendMessge   
  
常量的命名  
  
  常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。  
  例如: MAX_VALUE  
  
参数的命名  
  
  参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。
 
变量的命名  
  
   所有字母都使用小写。使用'_'作为每个词的分界  
  通过这一途径,代码中变量的作用域是清晰的。所有的变量在代码中都看起来不同,容易辨认。

当输出单引号和双引号的效果一样时一律使用双引号。   

分享到:
评论

相关推荐

    PHP代码书写规范

    PHP代码书写规范是为了提高代码可读性、可维护性和团队协作效率而设立的一套指导原则。这些规范涵盖了文件命名、变量、常量、函数、类以及编码格式等多个方面。遵循这些规范,可以帮助程序员避免常见的错误,提升...

    C++语言代码书写规范

    为了确保代码的一致性、可读性和可维护性,制定一套统一的代码书写规范至关重要。本文档旨在提供一份详尽的C++代码书写规范指南,帮助开发人员尤其是初学者建立起良好的编程习惯。 #### 目的 本文档的目的在于为...

    java代码书写规范

    Java代码书写规范是Java软件开发中的重要组成部分,它旨在提升代码的质量、可读性和可维护性,从而提高开发效率和团队协作效果。遵循一套统一的编程标准,可以帮助开发者避免不必要的误解,减少错误,并使得代码更加...

    Verilog代码书写规范

    本文旨在介绍一套针对Verilog的代码书写规范,以提高代码的可读性、可维护性和可重用性。 #### 二、目的 本规范的主要目标是通过制定统一的编码标准,确保Verilog代码具备以下特点: 1. **逻辑功能正确**:确保...

    C++编程代码书写规范.zip

    这份名为"C++编程代码书写规范"的资料提供了一套详细的指导原则,旨在帮助开发者编写高质量的C++代码,并提供了150条具体的改善建议。下面我们将详细探讨这些关键知识点。 1. **命名规范**:良好的命名是代码可读性...

    C++源码书写及注释规范

    首先,我们来讨论C++源码的书写规范。源码的书写主要包括变量命名、函数命名、类命名以及代码结构等几个方面。 1. **命名规范**:C++中通常采用驼峰命名法或下划线命名法。变量名应简洁明了,反映其作用;函数名应...

    C# 代码编写规范

    C#代码编写规范是一套为.NET平台软件开发人员量身定做的编程规范,它涵盖了从命名规则到注释、编码、编程准则、代码包规范以及代码控制等多方面的详细规定。这些规范旨在统一开发设计过程,提高代码的可读性和可管理...

    阿里巴巴1.4代码书写规范word版本

    ### 阿里巴巴1.4代码书写规范详解 #### 前言 阿里巴巴Java开发手册1.4版,作为一套全面而详细的编程规范指南,旨在帮助开发人员提高代码质量和可维护性。该手册覆盖了从编码风格到工程实践的各个方面,通过一系列...

    编程书写规范.pdf

    从给定的文件信息来看,虽然标题和描述指向的是编程书写规范,但文件内容主要涉及IT就业指南,包括自我认知、职场心态调整、入职初期的行为准则以及职场发展策略等内容。因此,下面的知识点将围绕这些方面展开,同时...

    代码书写规范

    综上所述,遵循一套良好的代码书写规范是提升代码质量和开发效率的重要手段。通过对代码格式、命名、注释等方面的规范化管理,不仅可以增强代码的可读性和可维护性,还能促进团队内部的协作效率。同时,不断地学习...

    华为代码规范代码模板

    华为作为全球领先的ICT解决方案提供商,对于代码质量有着极高的要求,因此制定了一套详尽的代码规范。这套规范不仅适用于Java语言,也可能覆盖其他编程语言,以确保代码的一致性和专业性。 首先,我们要理解“代码...

    Delphi 源程序格式书写规范

    ### Delphi 源程序格式书写规范 #### 1. 规范简介 Delphi是一种广泛应用于Windows平台的快速应用程序开发工具,它基于Object Pascal语言。为了提高代码的可读性和可维护性,制定一套统一的编程规范尤为重要。本...

    华为代码设计规范

    综上所述,华为的代码设计规范是一套全面而严格的指南,它不仅规定了代码的书写格式和风格,还深入到代码的质量、效率和测试等方面,旨在培养一支高素质的软件开发团队,产出高质量的软件产品。遵循这套规范,不仅...

    VC代码书写规范[归类].pdf

    《VC编程规范》是指导程序员遵循的一套标准,旨在提高代码的可读性、可维护性和团队协作效率。本文档主要关注的是Visual C++(VC)编程中的代码格式和风格,以下是一些关键要点的详细解释: 1. **程序块缩进**:...

    VC代码书写规范[参照].pdf

    《VC编程规范》是指导软件开发人员在使用Visual C++进行编程时,遵循的一套标准和准则,旨在提高代码的可读性、可维护性和团队协作效率。以下是一些主要的规范要点: 1. **排版格式约定**: - 程序块的缩进以一个...

    C#基本书写规范

    遵循一套良好的编码规范对于任何编程语言来说都是至关重要的,它不仅有助于代码的可读性和可维护性,还能提高团队协作效率。以下是对"C#基本书写规范"的详细解读。 1. **命名规范** - 类(Class):类名应使用...

    PHP编码书写规范

    本文将详细探讨PHP编码书写规范,旨在帮助开发者写出更加清晰、易读的代码。 1. **命名规范** - 变量命名:推荐使用下划线分隔的驼峰命名法,如`$user_name`。避免使用单字符变量,除非在循环中。 - 函数名:同样...

    SOC平台 verilog 代码风格规范V0.4.doc

    为了确保代码的可读性、可维护性和团队协作效率,制定了一套Verilog代码风格规范。以下是对这份"SOC平台 Verilog 代码风格规范V0.4"的详细解读。 ### 前言 前言指出,这份规范旨在统一团队在研发项目中使用Verilog ...

Global site tag (gtag.js) - Google Analytics