首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >如何加强自己对Java的编码规范

如何加强自己对Java的编码规范

作者头像
小Bob来啦
发布于 2021-07-29 03:20:37
发布于 2021-07-29 03:20:37
6240
举报
大家好,我是小Bob,一个关注软件领域而又执着于计算机底层的开发者~

Java,无疑是现在计算机专业最容易找到工作的语言,使用的人也非常多,各大语言排行榜前三一般都会有Java。

那么,关于Java的使用小编这里先从它的编码规范开始,比如经常使用到的一些标识符以及关键字和注释。

一.标识符

首先,学Java要先弄清它的一些文件结构,这个我们下次会讲解。这里先说说它的标识符,简单来说,标识符是关于类、接口、方法、变量等起名字时使用的字符序列。

关于编程时使用标识符的一些规则

  • 字母、数字、下划线(_)、$所组成。
  • 不能使用数字开头。
  • 不能使用Java的关键字。
  • 区分大小写。

To:在使用变量时,由于utf-8支持中文,所以是可以使用中文变量的,但小编不建议使用,如果编码不同,实际上很容易出现问题。

上面说到字符序列有类、接口、方法、变量等,下面来逐一介绍:

(1)类、接口、命名规则:

单个单词、首字母大写、其余小写

举例:Hello

多个单词:每个单词的首字母都大写,其余单词小写

举例:HelloWorld

(2)变量、方法命名规则:

单个单词:字母全小写

举例:check()

多个单词:首字母小写、后面每个单词首字母大写

举例:checkUserName()

(3)常规命名规则:

单个单词:字母全部大写

举例:NUMBER

多个单词:字母全部大写、中间使用下划线隔开

举例:MAX_VALUE

To:切记定义变量时不能用数字开头。

二.源代码注释

关于注释,华为的标准是源程序中代码的注释量要达到30%以上,而且注释的内容要清晰明了,含义准确。间接的说明在敲代码时注释的重要性。

那么Java中注释有三种类别

  • 单行注释://
  • 多行注释:/* */
  • 文档注释:/** */(文档注释Javadoc生成的文档)

关于文档注释,便是通过命令来对源代码进行一定的信息补充,下次在使用Eclipse时将会讲到。

本质上来说,注释就是编译器在进行程序编译的时候,如果发现有注释的内容将不对此部分进行编译处理。Java中可以把注释分为三种:类注释、多行注释和单行注释。

三.相关规则总结

最后,关于程序的排版规则和命名规则:

排版规则:

1.程序块采用缩进规则,缩进的空格为四个,不允许使用TAP缩进。

2.分界符(如大括号{}各占一行)应各独占一行,同时与引用他们的语句左对齐。

3.较长的语句、表达式或参数(>=80字符)要分成多行书写。

4.不允许把多个短语句写在一行中,即一行只写一条语句,定义变量后应该空一行。

5.if for do while case switch default等语句各自占一行。

6.if for do while等语句的执行语句部分无论多少都要加括号。

命名规则:

1.类名和接口名使用意义完整的英文描述:每个英文单词的首字母使用大写,

其余字母使用小写的大小混合法。

2.方法名使用类意义完整的英文描述:第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的混合法。

3.属性名使用完整意义的英文描述:第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的大小写混合法。

4.常量名使用全大写的英文描述:语文单词之间使用下划线分隔开,并且使用static final修饰。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-07-22,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 程序员Bob 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
AIOps系列 | Agent 入门实战
作者:乔克 公众号:运维开发故事 博客:https://jokerbai.com
没有故事的陈师傅
2025/08/01
1600
AIOps系列 | Agent 入门实战
初识langchain[1]:Langchain实战教学,利用qwen2.1与GLM-4大模型构建智能解决方案[含Agent、tavily面向AI搜索]
大模型三大重点:算力、数据、算法,ReAct (reason推理+act行动)–思维链
汀丶人工智能
2024/07/25
1.9K0
初识langchain[1]:Langchain实战教学,利用qwen2.1与GLM-4大模型构建智能解决方案[含Agent、tavily面向AI搜索]
大模型 API 调用从 0 到 1 (以智谱 AI 为例)
在 NoteBook 中,我们可以通过虚拟环境安装指定版本的 Python,具体教程请参考:ModelArts codelab 创建虚拟环境切换 Python
胡琦
2025/05/20
6410
大模型 API 调用从 0 到 1 (以智谱 AI 为例)
从API到Agent:万字长文洞悉LangChain工程化设计
我想做一个尝试,看看能不能用尽量清晰的逻辑,给“AI外行人士”(当然,我也是……)引入一下LangChain,试着从工程角度去理解LangChain的设计和使用。同时大家也可以将此文档作为LangChain的“10分钟快速上手”手册,本意是希望帮助需要的同学实现AI工程的Bootstrap。
GeaFlow
2024/03/18
1.5K1
从API到Agent:万字长文洞悉LangChain工程化设计
洞悉LangChain:LangChain工程化设计,从API到智能Agent的全面探索
LangChain 是 2022 年 10 月底,由哈佛大学的 Harrison Chase 发起的基于开源大语言模型的 AI 工程开发框架。当然也可以问一下 AI:
汀丶人工智能
2024/07/25
1.8K0
洞悉LangChain:LangChain工程化设计,从API到智能Agent的全面探索
通过4个任务比较LangChain和LlamaIndex
我们在本地使用大模型的时候,尤其是构建RAG应用的时候,一般会有2个成熟的框架可以使用
deephub
2024/01/29
2.2K0
通过4个任务比较LangChain和LlamaIndex
大模型实战|企业知识库问答系统构建全流程:从数据接入到RAG架构落地
尤其是信息孤岛林立、知识文档散落在各业务系统的企业中,员工在寻找答案的时间,可能比解决问题本身还久。这不禁让我思考:有没有一种方式,能让大家像用ChatGPT一样,在公司内部随时提问,立刻获得准确、专业的回答?
Echo_Wish
2025/07/19
5211
大模型实战|企业知识库问答系统构建全流程:从数据接入到RAG架构落地
LLM运行框架对比:ollama与vllm浅析
开源的LLM已经成为程序员、爱好者和希望在日常工作中使用生成式AI并保持隐私的用户的最佳选择,对于企业的私有化部署而言也是如此。这些模型提供了优秀的性能,有时在许多任务中可以与大型的闭源模型 (如 GPT-4o 或 Claude Sonnet 3.5) 相媲美。
半吊子全栈工匠
2025/03/10
2.3K1
LLM运行框架对比:ollama与vllm浅析
大模型开发实战:(四)使用 LangGraph 实现多智能体应用
随着大语言模型(LLM)技术的快速发展,人们期望利用 LLM 解决各种复杂问题,在此背景下,构建智能体(Agent)应用受到了广泛关注。用户与 LLM 的交互可以被视为一种 单智能体(Single-Agent) 行为:用户通过提示词(prompt)与通用 LLM 进行对话,LLM 理解问题并提供反馈。然而,单一智能体在处理复杂任务时存在明显局限性,例如需要用户多次引导、缺乏对外部环境的感知能力、对话历史记忆有限等。
张高兴
2025/05/21
1.6K1
大模型开发实战:(四)使用 LangGraph 实现多智能体应用
前端通过 LangChain 接入任意大模型探索
目前带大模型产品也越来越多,微软将大模型能力融入office全家桶,谷歌将大模型融入搜索引擎、邮箱、地图、视频网站等谷歌全家桶、Meta用AI能力服务广告商,帮助其撰写营销文案,生成广告概念图……
记得程序有解
2024/04/03
3.2K1
前端通过 LangChain 接入任意大模型探索
使用GraphRAG+LangChain+Ollama:LLaMa 3.1跑通知识图谱与向量数据库集成(Neo4j)
我将向你展示如何使用 LLama 3.1(一个本地运行的模型)来执行GraphRAG操作,总共就50号代码。。。
AI进修生
2024/12/02
1.8K0
使用GraphRAG+LangChain+Ollama:LLaMa 3.1跑通知识图谱与向量数据库集成(Neo4j)
使用 TiDB Vector 搭建 RAG 应用 - TiDB 文档问答小助手
继上一次《TiDB Vector抢先体验之用TiDB实现以图搜图》后,就迫不及待的想做一些更复杂的应用。上一篇在 TiDB 社区专栏发布以后还是有很多社区朋友不明白向量的应用场景到底是什么,这次用一个更直观的场景来体现向量检索在 AI 应用开发的重要性。
HOHO
2024/06/05
3310
使用 TiDB Vector 搭建 RAG 应用 - TiDB 文档问答小助手
一文入门最热的LLM应用开发框架LangChain
LangChain 的作者是 Harrison Chase,最初是于 2022 年 10 月开源的一个项目,在 GitHub 上获得大量关注之后迅速转变为一家初创公司。2017 年 Harrison Chase 还在哈佛上大学,如今已是硅谷的一家热门初创公司的 CEO,这对他来说是一次重大而迅速的跃迁。Insider 独家报道,人工智能初创公司 LangChain 在种子轮一周后,再次获得红杉领投的 2000 万至 2500 万美元融资,估值达到 2 亿美元。
腾讯技术工程官方号
2023/08/18
4.5K1
一文入门最热的LLM应用开发框架LangChain
DeepSeek 本地化新篇章:Ollama 兼容 OpenAI API 的深度解析与部署实践
随着大语言模型(LLM)的快速发展,开发者对本地化部署和 API 兼容性的需求日益增加。Ollama 作为一个轻量级开源框架,通过兼容 OpenAI API 的接口设计,为本地运行 DeepSeek 等大模型提供了便捷途径。本文深入探讨 Ollama 如何实现与 OpenAI API 的无缝对接,结合 DeepSeek 模型的本地部署,展示其在文本生成、聊天对话及流式响应中的应用。从安装配置到高级功能实现,本文提供了大量带中文注释的 Python 代码示例,涵盖 Curl 请求、SDK 调用及错误处理等内容。此外,文章还分析了这种兼容性的优势与局限,适合希望在无 GPU 环境下运行 DeepSeek 或迁移 OpenAI 项目的开发者。通过本文,读者将掌握如何利用 Ollama 将 DeepSeek 等模型融入本地化开发,充分发挥其潜力。
蒙娜丽宁
2025/04/15
1.9K0
DeepSeek 本地化新篇章:Ollama 兼容 OpenAI API 的深度解析与部署实践
如何从文档创建 RAG 评估数据集
通过上传 PDF 文件并将其存储在矢量数据库中,我们可以通过矢量相似性搜索检索这些知识,然后将检索到的文本作为附加上下文插入到 LLM 提示中。
致Great
2025/01/03
1.3K0
如何从文档创建 RAG 评估数据集
我为什么放弃了 LangChain?
如果你关注了过去几个月中人工智能的爆炸式发展,那你大概率听说过 LangChain。
机器之心
2023/08/08
1.4K0
我为什么放弃了 LangChain?
LangChain大模型应用开发
LangChain作为一个新兴的框架,旨在简化大模型应用的开发过程。它提供了一套工具和接口,帮助开发者将大模型无缝集成到各种应用场景中。通过LangChain,开发者可以更专注于业务逻辑的实现,而不必过多关注底层模型的复杂性。
@小森
2024/12/04
2951
LangChain大模型应用开发
利用知识图谱提高 RAG 应用的准确性
在 RAG 应用中使用 Neo4j 和 LangChain 构建和检索知识图谱信息的实用指南
大数据杂货铺
2024/04/02
9970
利用知识图谱提高 RAG 应用的准确性
LLM 大模型学习必知必会系列(十三):基于SWIFT的VLLM推理加速与部署实战
使用LoRA进行微调的模型你需要先merge-lora, 产生完整的checkpoint目录.
汀丶人工智能
2024/05/29
1.4K0
LLM 大模型学习必知必会系列(十三):基于SWIFT的VLLM推理加速与部署实战
AI智能体(四)
以往,我们都是直接跟大模型进行交互,没有办法系统的实现记忆。langchain给出了一个系统级的解决方案,如上图中,用户提出问题,系统会先在存储器(如上图中的redis)中查询相关的文档返回系统,系统会带着用户的问题以及查询到的文档碎片一起提交给大模型,然后再将答案返回给用户。其中存储器充当了大脑记忆的部分。在上图的左下角,就是我们之前说的各种文档(pdf,word,excel等)通过向量化后存储进存储器。比起直接向大模型提问,langchain相当于多了一个外挂系统。
算法之名
2025/02/06
3050
AI智能体(四)
推荐阅读
相关推荐
AIOps系列 | Agent 入门实战
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档