精华内容
下载资源
问答
  • java命名规范--入门Java程序员必看
    千次阅读
    2022-02-03 00:17:22

    一、项目名称

    最好用英文,所有单词全部用小写,如testjavaproject、studentmanagement等,当然也也可以用中文,如“学生管理系统”、”进销管理系统“等。

    二、Java project中相关命名

    1、包名:全部小写字母,最好用域名反过来写,不会冲突。如com.cnblogs.lionestking.myutil等。

    2、类名:每个单词首字母均大写,且public类应用项目同名.

    3、方法名和对象名(变量名):除第一个单词首字母小写外(若只能一个单词,就全部小写),其余单词首字母均大写。方法名采用动词+名词或动词表示,如append()、getName()等。

    4、属性名:和对象命名方法相同,采用名词或形容词+名词的形式表示,如name、dbClassName、dbUser、dbPassword、dbUrl等。

    5、常量:均大写,可以加一些前缀,以_进行分隔。

    三、属性文件.properties定义变量命名

    object.a_b_c格式,全部小写,其中object是宿主,a_b_c多个单词下划线分开。

    例:hibernate.cache.use_second_level_cache,hibernate.cache.provider_class,hibernate.cache.provider_configuration_file_resource_path

    四、xml文件命名

    全部小写,-符号是其xml的用途说明,类似applicationContext属习惯命名。比如springmvc-servlet.xml、workdesk-manager.xml、workdesk-servlet.xml、applicationContext-basic.xml等

    xml里的内容多个字符间以-隔开,比如param-name,filter-mapping等。

    五、普通文件命名(jsp,js,img等)和java普通变量规范相同。

    六、属性文件properties

    以下划线隔开:errors_zh_CN.properties,hibernate_test.properties

    六、数据库命名:表、字段命名全部大写,多个单词以_隔开。

    更多相关内容
  • Java命名规范

    2021-02-28 13:08:53
    成员函数做什么以及它为什么做这个 哪些参数必须传递给一个成员函数 成员函数返回什么 已知的问题 任何由某个成员函数抛出的异常 成员函数是如何改变对象的 包含任何修改代码的历史 如何在适当情况下调用成员函数的...

    1. 编码统一设置为UTF-8

    2. 代码的组织与风格:

    2.1 一个代码块的缩进统一为4个空格,使用Tab键,不是敲4下空格

    2.2 空格:A.所有的二元运算符,除了“.”,应该使用空格将之与操作数分开。一元操作符和操作数之间不应该加空格,比如:负号(“-”),自增(“++”)和自减(“--”)。

    B.括号和它里面的字符之间不要出现空格。括号应该和它前边的关键词留有空格。

    C.方法和左括号之间不要空格。

    D.二元操作符和操作数之间要用空格隔开。

    2.3 在方法、局部变量和后边的语句之间、方法内部的逻辑部分之间需要有一个空行,不要有多个空行,也不要没有空行。

    2.4 一行代码的长度不要超过当前编辑页的宽度,也就是编辑页下方的左右拉动条不要出现。如果一行代码长度超过了当前编辑页的宽度(通常为表达式),则需要换行,换行需要注意:

    A) 在一个逗号后面断开。

    B) 在一个操作符前面断开。

    C) 新的一行应该与上一行同一级别表达式的开头处对齐。

    2.5 每一个函数的有效代码(不包括注释和空行)不要超过50行,如果超过50行,则审视代码,可将一些功能性的代码单独提出,写成一个方法。

    2.6 注释

    2.6.1 保持注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性。如果语句块(比如循环和条件分枝的代码块)代码太长,嵌套太多,则在其结束“}”要加上注释,标志对应的开始语句。如果分支条件逻辑比较复杂,也要加上注释。

    2.6.2 块注释:主要用来描述文件,类,方法,算法等,放在所描述对象的前边。

    /**

    *作者,创建日期,修改日期,描述内容

    */。

    2.6.3 行注释:主要用在方法内部,对代码,变量,流程。整个注释占据一行。

    2.6.4 尾随注释:与行注释功能相似,放在代码的同一行。

    2.6.5 注释内容

    项目

    注释哪些部分

    参数

    参数用来做什么

    任何约束或前提条件

    字段/属性

    字段描述

    类的目的

    已知的问题

    类的开发/维护历史

    接口

    目的

    它应如何被使用以及如何不被使用

    局部变量

    用处/目的

    成员函数注释

    成员函数做什么以及它为什么做这个

    哪些参数必须传递给一个成员函数

    成员函数返回什么

    已知的问题

    任何由某个成员函数抛出的异常

    成员函数是如何改变对象的

    包含任何修改代码的历史

    如何在适当情况下调用成员函数的例子适用的前提条件和后置条件

    成员函数内部注释

    控制结构

    代码做了些什么以及为什么这样做

    局部变量

    难或复杂的代码

    处理顺序

    2.6.6 程序修改注释

    新增代码行的前后要有注释行说明,对具体格式不作要求,但必须包含作者,新增时间,新增目的。在新增代码的最后必须加上结束标志;

    修改代码行建议以删除代码行后再新增代码行的方式进行(针对别人的代码进行修改时,必须标明,对于自己的代码进行修改时,酌情进行)。注释方法和内容同新增;

    2.7    变量的声明,需要归类放置。

    3 命名

    3.1 命名的基本约定

    3.1.1 使用可以准确说明变量/字段/类的完整的英文描述符,如firstName。对一些作用显而易见的变量可以采用简单的命名,如在循环里的递增(减)变量就可以被命名为i。

    3.1.2 尽量采用项目所涉及领域的术语。

    3.1.3 采用大小写混合,提高名字的可读性。为区分一个标识符中的多个单词,把标识符中的每个单词的首字母大写。不采用下划线作分隔字符的写法。有两种适合的书写方法。适用于不同类型的标识符:

    PascalCasing:标识符的第一个单词首字母小写。

    CamelCasing:标识符的第一个单词首字母大写。

    标识符

    大小写

    示例

    命名空间

    Pascal

    namespace Com.Techstar.ProductionCenter

    类型

    Pascal

    public class DevsList

    接口

    Pascal

    public interface ITableModel

    方法

    Pascal

    public void UpdateData()

    属性

    Pascal

    Public int Length{…}

    事件

    Pascal

    public event EventHandler Changed;

    私有字段

    Camel

    private string fieldName;

    非私有字段

    Pascal

    public string FieldName;

    枚举值

    Pascal

    FileMode{Append}

    参数

    Camel

    public void UpdateData(string fieldName)

    局部变量

    Camel

    string fieldName;

    3.1.4 尽量避免使用缩写,使用时,需要保留标准缩写列表。两个字母的缩写要采用统一大小写的方式(ioStream,getIOStream)。多字母缩写采用首字母大写,其他字母小写的方式(GetHtmlTag)。

    3.1.5 避免使用长名字。

    3.1.6 避免使用相似或者仅在大小写上有却别的名字。

    3.2 类和接口的命名

    3.2.1 类的名字要用名词。

    3.2.2 接口的名字要以I开头,保证其实现只和接口的名字差一个I字母。

    3.2.3 方法命名:第一个单词一般为名词。

    3.2.4 方法的重载规范:

    A.如果重载中某个参数表示同一种输入,则要用相同的名字。

    B.避免重载成员的参数顺序不一致,同名参数应该出现在相同位置。

    C.要允许参数可为null

    HTML、JS、java编码规范大同小异。

    HTML编码规范

    1. 小写所有字母。

    2. 样式和脚本使用引用的方式。

    3. 标签一定要有结束标记。

    4. 属性值要用双引号,属性一律小写。

    5. 标签要合理嵌套。

    6. 图片中一定要有alt属性。

    7. 属性中的width,height一律使用百分比。

    8. 标签要有缩进,统一为4个空格,即一个Tab。

    9. 需要有适当的注释。

    10. 一个标记必须占据一行。不得出现两个标记出现在同一行的情况。

    11. 最高一级采用左对齐顶格的方式书写。下一级采用左对齐向右缩进一个Tab的方式书写。

    12. 同一级的标记必须上下对齐。

    JavaScript编码规范

    1. 所有变量必须声明。

    2. 将var语句放在函数的首部。

    3. 变量尽量采用小写,全局变量全部大写。

    4. 右花括号后面必须跟随分号。

    数据库编码规范

    1. 表名单词首字母一律大写

    2. 视图以VI_开头

    3. 触发器以TRI_+触发器名称+_IUD(I为insert,U为update,D为delete)

    4. 存储过程以P_开头

    5. 注释格式为:

    --===================

    --功能

    --作者

    --时间

    --返回值

    --====================

    开发过程中的文档要求

    1. 需求文档(完整的)

    2. 概要设计文档(完整的)

    3. 详细设计文档(完整的)

    4. 数据库设计文档,包括表说明,字段说明,触发器说明,存储过程说明,视图说明等。

    5. 开发日志,项目经验。

    格式为:时间,姓名,主题,解决方案。

    6. 测试文档

    展开全文
  • java命名规范

    千次阅读 2021-03-22 16:40:08
    一、命名规范1、 项目名全部小写2、 包名全部小写3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。如:public class MyFirstClass{}4、 变量名、方法名首字母小写,如果名称由多个单词组成...

    一、命名规范

    1、 项目名全部小写

    2、 包名全部小写

    3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

    如:public class MyFirstClass{}

    4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

    如:int index=0;

    public void toString(){}

    5、 常量名全部大写

    如:public static final String GAME_COLOR=”RED”;

    6、所有命名规则必须遵循以下规则:

    1)、名称只能由字母、数字、下划线、$符号组成

    2)、不能以数字开头

    3)、名称不能使用JAVA中的关键字。

    4)、坚决不允许出现中文及拼音命名。

    二、注释规范

    1、 类注释

    /**

    Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

    FileName: Test.java

    类的详细说明

    @author 类创建者姓名

    @Date 创建日期

    @version 1.00

    */

    2、 属性注释

    在每个属性前面必须加上属性注释,注释模板如下:

    /** 提示信息 */

    private String strMsg = null;

    3、 方法注释

    在每个方法前面必须加上方法注释,注释模板如下:

    /**

    类方法的详细使用说明

    @param 参数1 参数1的使用说明

    @return 返回结果的说明

    @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    4、 构造方法注释

    在每个构造方法前面必须加上注释,注释模板如下:

    /**

    构造方法的详细使用说明

    @param 参数1 参数1的使用说明

    @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    5、 方法内部注释

    在方法内部使用单行或者多行注释,该注释根据实际情况添加。

    9a9ba11fac41

    image

    最新2020整理收集的一些高频面试题(都整理成文档),有很多干货,包含mysql,netty,spring,线程,spring cloud、jvm、源码、算法等详细讲解,也有详细的学习规划图,面试题整理等,需要获取这些内容的朋友请加Q君样:909038429

    /./*欢迎加入java交流Q君样:909038429一起吹水聊天

    展开全文
  • java方法命名规范(持续更新)

    千次阅读 2020-07-24 15:12:06
    前言:命名的目的是见名知意。业界目前没有强制的命名规范,但是用过了JPA之类的人,自己新建DAO层的方法的时候,也有一个参考,所以,用hibernate那一套,其实挺好的,维护起来也是很方便。 增删查改的方法的命名...

    前言:命名的目的是见名知意。业界目前没有强制的命名规范,但是用过了JPA之类的人,自己新建DAO层的方法的时候,也有一个参考,所以,用hibernate那一套,其实挺好的,维护起来也是很方便。

    增删查改的方法的命名规范

    1. 这套是阿里的,对应增删改查:
      在这里插入图片描述
    2. 这套是我觉得也不错的:
    • Dao 接口命名:这里的方法名字最好对应着sql语句,这是最直接的。然后表示条件用By作为介词,表示查询列表用list前缀。

    insert :插入
    batchInsert :批量插入
    selectOne :查询一个数据
    selectById :查询通过xx条件
    count :计数
    selectList :查询多个数据
    update :更新
    deleteById :删除,通过某些条件

    • Service 接口命名:这里用的是解决人类的思维,查询就是find,添加是add,删除就是remove,修改是modify。然后条件也用by,大量用list后缀。

    add :添加数据
    findById :查找,也可以用query
    findByXXX :查找
    findXXXList :批量查找
    modify :修改
    remove : 简单删除

    其他命名规范

    1. 项目名全部小写.
    2. 包名全部小写.
    3. 类名:大驼峰,例如:UpperCamelCase
    4. 变量名,方法名:小驼峰:lowerCamelCase
    5. 常量名全部大写: public static final int REQUEST_KEY_CODE =1;
    6. 所有命名规则必须遵循以下规则 :
    • 名称只能由字母、数字、下划线、$符号组成.
    • 不能以数字开头.
    • 名称不能使用Java中的关键字.
    • 坚决不允许出现中文及拼音命名.
    展开全文
  • 存取函数以<code>Java风格命名,具体请参考主函数中的代码。 一共包含2个文件,<code>main.cpp和<code>Int.h。 用户仅能修改<code>Int.h中的内容。 <code>main.cpp的内容如下:   <ol><li>...
  • 主要介绍了 Java 回调函数深入理解的相关资料,需要的朋友可以参考下
  • java函数的定义以及使用方法介绍

    千次阅读 2021-02-25 19:08:15
    java函数的定义以及使用方法介绍发布时间:2020-04-24 16:28:40来源:亿速云阅读:116作者:小新今天小编给大家分享的是java函数的定义以及使用方法介绍,相信很多人都不太了解,为了让大家更加了解java函数,所以给...
  • 下面的代码在window对象中创建一个命名空间 mySpace,并把自执行函数中的方法封装在mySpace命名空间之下,以便于我们调用这个自执行函数中的一些功能。 代码如下: (function() { //根据id获取对象 function $(id) {...
  • Python 变量函数命名规则

    千次阅读 2021-04-25 09:50:56
    全局变量名(类似于 Java 中的 static 变量) 纯大写,单词之间用 _ 分割 普通变量 纯小写字母,_ 分割 私有实例变量(外部访问会报错) 以 __ (两个下划线)开头,其余和普通变量保持一致 专有变量 __ ...
  • java 方法(函数)详解

    千次阅读 2021-01-30 21:02:41
    java 函数详解基本概念注意:主函数main() 解释public static void main(String[] args) 含义函数的参数传递java自定义方法(函数)1. 无参无返回值方法2. 无参带返回值方法3. 有参无返回值方法有参有返回值方法完整...
  • java中的函数式接口

    2022-01-22 21:01:08
    java中的函数式接口
  • java构造函数怎么写

    千次阅读 2021-03-01 07:47:12
    java构造函数怎么写发布时间:2020-06-29 11:50:19来源:亿速云阅读:114作者:Leahjava构造函数怎么写?针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易...
  • Java代码命名规范

    2012-03-30 00:10:05
    Java初学者没有规范的命名习惯,会给以后的开发带来麻烦,最好就是在初学的时候注意变量、函数等的命名
  • java入口函数有几种

    千次阅读 2021-02-12 15:37:12
    java入口函数有几种java入口函数只有一种,而且必须以main命名,且以public static进行修饰。入口(Entry of Program):指程序运行的起点。只有main方法可以作为程序的入口。main方法结构:public static void main...
  • Java 构造函数函数重载

    千次阅读 2021-03-01 08:44:38
    构造函数:⑴方法名和类名相同,而且没有返回类型(包括 void 也没有);⑵没有返回值;⑶如果没有输入构造函数,jvm会自动帮我们创建一个不带参数,没有任何函数体的的构造函数;如果我们手动的创建了其他构造函数,...
  • Java用户自定义函数

    千次阅读 2021-02-25 20:31:15
    用户除了可以使用JavaScript的内置函数之外,还可以自己定义函数。自定义函数有3种方法。使用关键字 function 构造语法:function funcName([param1][,param2...}){statements;}使用 function 构造语法:var result ...
  • 我们给变量、函数、参数、类和包命名。我们给源代码及源代码所在目录命名。这么多命名要做,不妨做好它。下文列出了取个好名字的几条简单规则。名副其实,见名知意变量名太随意,haha、list1、ok、theList 这些都没啥...
  • java类与方法命名规则

    2013-08-21 21:57:27
    class命名:每一个单词的首字母大写,中间无需连接符。 函数、变量命名:第一个单词的首字母小写,其余同上。
  • 主要介绍了学习不同 Java.net 语言中类似的函数结构,函数式编程语言包含多个系列的常见函数。但开发人员有时很难在语言之间进行切换,因为熟悉的函数具有不熟悉的名称。函数式语言倾向于基于函数范例来命名这些常见...
  • 详解Java的main函数

    万次阅读 多人点赞 2019-04-03 19:32:40
    自接触java第一天起,老师就在教:第一行写 public static void main(String[] args) “为什么要这么写等你们以后就知道了” 曾经好奇问过别人,得到的答复基本都是“规定”。最近手头闲下来了,翻看了一下单例与...
  • java给线程命名_Java命名线程

    千次阅读 2020-07-28 11:15:16
    java给线程命名 Java命名线程 (Java Naming Thread) Each thread in Java has its own name which is set by the JVM by default. Although there are many other attributes associated to the thread like: id, ...
  • JavaScript常见变量和函数命名示例

    万次阅读 2020-07-21 15:16:17
    JavaScript作为前端开发从业人员必须掌握的3大基础知识中最重要的一环,也是平是接触时间最长、写得最多的。在开发过程中必然会遇到命名的问题,你会词穷...JavaScript常见变量和函数命名示例思维导图 需要注意的是由
  • 包含了Java命名规范。包括文件,变量,注释,函数名等等的规范. 包含了4个文件(变量,注释,空格等等分类列示)
  • java函数定义

    千次阅读 2018-07-26 21:23:53
    import java.util.Scanner;//导入类 /*  * 函数的功能:简化了代码,增加了代码的复用性,提高了代码的安全性,简化了相应的操作  *   *   * 函数的构成:修饰词 返回值 函数名(参数列表){//函数体  * ...
  • java命名规范:驼峰命名法则

    千次阅读 2020-04-28 09:37:06
    java命名规范:驼峰命名法则 使用前注意事项: 1、由于Java面向对象编程的特性, 在命名时应尽量选择名词 2、驼峰命名法(Camel-Case): 当变量名或函式名是由一个或多个单字连结在一起,而构成的唯一识别字时,首...
  • 为什么函数Java中被称为方法?

    千次阅读 2021-03-11 12:56:18
    为什么Java社区选择命名它们的方法。这个决定背后有什么具体的原因吗?还是只是一个名字?当我想到字面意义的时候,就我所能想到的来说,函数与一些机器的内部工作有关。方法是实现目标的一种工作方式(数学解),或者...
  • Java变量命名规范

    万次阅读 2019-03-31 11:48:50
    Java是一种区分字母大小的语言,因此我们在定义变量的时候应该注意区分大小写的使用和一些规范,下面简单的讲讲。 (一)Package(包)的命名 1、package命名要求包含的所有字符均为小写,同时不能有特殊字符。 2、...
  • java类方法属性的命名规范介绍

    千次阅读 2021-02-12 22:42:09
    java类方法属性的命名规范介绍,java命名总结。一个优秀的程序员,首先要培养良好的编程习惯,为了提高代码的可读性,必须有好的命名规范。这篇文章是小编结合网上的很多资料整理出来的,若有不当或错误的地方,欢迎...
  • Java日志记录函数调用栈方法

    千次阅读 2022-02-21 15:43:11
    关于getStackTrace() public StackTraceElement[] getStackTrace() 返回一个表示该线程堆栈转储的堆栈跟踪元素...android/java 调用栈 将以下代码加入被调用的函数中即可 for (StackTraceElement i : Thread.current
  • 如何在Java中将函数作为参数传递?

    千次阅读 2021-02-12 12:23:10
    如何在Java中将函数作为参数传递?这个问题在这里已有答案:Java Pass方法作为参数 14个答案是否可以将方法作为参数传递给Java方法? 如果是这样,有人可以指导我吗? 这似乎并不重要Jason asked 2019-01-26T17:30:...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 245,078
精华内容 98,031
关键字:

java 函数命名

java 订阅