首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Java编程规范-注释

注释 加上注释,格式尽量和规范保持一致 Java 程序有两类注释: 实现注释 (implementation comments) 和 文档注释 (document comments) 。...文档注释 也称为 javadoc ,是 Java 所特有的,由 /** … */ 界定,可以通过 javadoc 工具转换成 HTML 文件,主要是描述代码段的说明,以编程手册的形式呈献给其他开发人员。...since表示从哪个版本开始就有这个类或者接口 @see引用 @deprecated表示不建议使用该类或者接口 示例: package com.dtdream.demo; import java.util.HashMap...; import java.util.Map; /** * Description...,但是必要的说明是需要的,格式尽量按照规范处理, 实体类用swagger模式也可 类属性的注释使用 javadoc 风格,放在属性 定义之前。

1.1K20
您找到你想要的搜索结果了吗?
是的
没有找到

Java编程规范及最佳实践

Java编程规范是为了保证代码的一致性和可读性而制定的一套编程规则和约定。本文将介绍一些主要的Java编程规范,以帮助读者编写更易于理解和维护的代码。...十一、Java集合框架 尽量使用Java集合框架的类和接口,如List、Set、Map等,而不是使用数组或自定义数据结构。 在可能的情况下,使用泛型来提高类型安全和减少类型转换。...使用Java的正则表达式库(java.util.regex)进行字符串匹配和验证。 十三、资源管理 在使用资源(如文件、数据库连接、网络连接等)时,确保及时关闭资源,防止资源泄漏。...以上是Java编程规范的一部分,具体规范可能会因项目和团队而异。遵循一致的编程规范可以使代码更易于理解和维护。 编程规范并不是一成不变的,随着技术的发展和团队的变化,可能需要对编程规范进行调整。...但是,无论如何,始终保持代码的一致性、可读性和可维护性是任何编程规范的核心目标。希望以上的编程规范和最佳实践能够帮助你写出更好的Java代码。

10010

Java编程规范-命名与语句

命名 建议按照此规范处理 UpperCamelCase 风格:每个单词首字母大写,其余字母小写; lowerCamelCase 风格:首单词全小写,后面每单词首字母大写,其余字母小写; 示例:...nowCustomerID 【正确用法】 UserInfo /* UpperCamelCase */ nowCustomerId /* lowerCamelCase */ 1包 按照此规范处理...示例: 【 错误用法】 import java.util. * ; 【正确用法】 import java.util.Map; import java.util.HashMap; import java.util.List...; import java.util.ArrayList; 3if-else 语句 按照此规范处理 1、if、else分支代码用大括号 {} 包围, else 与 if 的右大括号位于同一行,使用空格分开...= null) && (...) || (...); if (existed) { ... } 4for 语句 按照此规范处理 for语句作用范围代码用大括号{}包围。

43630

实用主义编程规范JAVA

JAVA代码规范 1.规范说明 此规范包含:避免出现常见恶劣代码的禁令;指导编写合格代码的基本规则 此规范不包含:分析与设计出符合业务需求的代码; 2.基本原则 a)规范代码的原因 写程序的过程中,读代码的时间和写代码的时间只比为...提交代码时,让代码比你打开的时候更规范 如果不随时执行规范规范将永远不会被执行 修改每行代码的时候,思考一下怎么写才是规范的,不要只急着完成功能 c)一号禁令 不可重复!...结构:公司域名.项目名.系统名.* 禁止使用纯数字作为包名的一个小节,因为JAVA规范不支持(如com.163....import java.awt.peer.CanvasPeer; 类和接口声明: i....是用标准的C++或者JAVA缩进格式,并且一直使用。禁止混用两种缩进格式。 iii.

1.2K60

Java开发编程规范: 1.命名风格

一.前言        这几天学习java写了一些东西,代码有问题,就拿去问老师,把代码发给老师后,老师批评说我写的代码不规范,即使代码可以实现相应的功能,但是企业依旧不会使用你的代码,你拥有的仅仅是编程基础...,老师不止一次告诉我,让我去学习编程规范,我觉得也是时候学习一波了,不知道各位读者有没有这种体验啊,比如一个QQ群,有萌新问你这个代码有什么问题,很多人想去帮忙,却不知道写的什么,才会一点一点问,这个方法是干什么的...正例:应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils(此规则参考 spring 的框架结构) 【强制】杜绝完全不规范的缩写,避免望文不知义。...【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。

79031

Python编程规范

1,Python编程规范 > 编码 所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 用于设置编辑器,默认保存为 utf-8 格式。...不同种类的模块间加空行; 3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔; > 断行 尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的最大长度不得超过...ThisIsAClass(object):pass >> 模块 模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如 module.py _internal_module.py >> 包 包的命名规范与模块相同...,大脑要同时处理两件事(编程和对齐);二是以后阅读和维护都很困难,因为人眼的横向视野很窄,把三个字段看成一行很困难,而且维护时要增加一个更长的变量名也会破坏对齐。...2,参考资料 Google Python编程风格指南 3,文档修改历史 发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/124465.html原文链接:https:/

84730
领券