前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >快来救救我的代码洁癖

快来救救我的代码洁癖

原创
作者头像
海风极客
发布2023-12-17 18:14:35
1613
发布2023-12-17 18:14:35
举报
文章被收录于专栏:扯编程的淡扯编程的淡

又来更文了~

熟悉我的小伙伴应该都知道,鄙人的职业生涯的一个小目标就是成为一名顶尖程序员,而且还会把这个目标时常挂在嘴边激励自己,为了能达到,自己也保持着广泛的学习和修炼,比如设计模式、架构理解、产品思维等等方面,而最近又想起一个很基础但又很重要的概念,这个概念在不同的编程语言,不同风格的程序员中可能不尽相同,那就是编码规范,概念上升一点,在有些编程语言和框架实践中还有概念:最佳实践。往往最佳实践都是基于编程规范的,那么这篇文章我们就先了解下编程规范,对了,还有代码洁癖~

浅说一下编程规范

编程规范是指为了提高程序可读性和可维护性而定制的一套规则和准则。在软件开发中,编程规范是非常重要的,它可以帮助团队成员共同遵守统一的代码风格,减少错误和冲突,提高代码的质量和可靠性。

编程规范包括变量的命名规则、函数的命名规则、类的命名规则、代码的对齐规则等等。统一的编程规范可以使不同开发人员编写的代码更加一致,减少沟通和协调的成本。这有助于提高团队协作效率,加快项目进度。

如果有读者阅读过开源项目的源码的话,就会知道大多数比较知名的开源项目都是有相对一致的编程规范的,还有就是在一些大厂中的开发也需要遵循基本的编程规范,比如:

喜欢的小伙伴可以去阅读下。

再说下我的"代码洁癖"

首先声明一下,我的"代码洁癖"可不是病态的,可能是因为实在找不到形容词了~

大概的表现就是看见不太优雅的代码就想优化,看见IDE里提示的波浪线还想优化,就比如Go语言中import的规范:

代码语言:go
复制
import (
   "net/http" //引用Go内置包

   "geek-blog-api/internal/logic/article" //引用项目本身的其他包
   
   "github.com/zeromicro/go-zero/rest/httpx"//引用三方包
)

错误案例(1):没有空格

代码语言:go
复制
import (
   "net/http"
   "geek-blog-api/internal/logic/article" 
   "github.com/zeromicro/go-zero/rest/httpx"
)

错误案例(2):顺序不对

代码语言:go
复制
import (
   "net/http" 

   "github.com/zeromicro/go-zero/rest/httpx"
    
   "geek-blog-api/internal/logic/article" 
)

还有就是参数声明:

看见这种IDE给提示的就很想把参数名给它加上:

除了这些之外还要很多,这里就不一一列举了。

代码不要过度优化

虽然代码优化有许多好处,我们要尽可能的遵守一些编程规范,但有时候不要为了规范而规范,过度的优化也有一些潜在的弊端,特别是修改一些别人写过的已经在运行中的代码。

过度优化可能会使代码变得复杂和难以理解,增加阅读和维护的难度。某些优化可能会对程序的性能产生负面影响,例如增加额外的计算或内存开销。在优化过程中,可能会引入新的错误或漏洞,导致程序出现不可预见的问题等等。

因此,在进行代码优化时,需要权衡利弊,根据实际情况选择合适的优化策略和方法。同时,应该始终保持代码的可读性和可维护性,避免过度优化带来的负面影响。

我正在参与2023腾讯技术创作特训营第四期有奖征文,快来和我瓜分大奖!

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

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

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

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

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 浅说一下编程规范
  • 再说下我的"代码洁癖"
  • 代码不要过度优化
相关产品与服务
Prowork 团队协同
ProWork 团队协同(以下简称 ProWork )是便捷高效的协同平台,为团队中的不同角色提供支持。团队成员可以通过日历、清单来规划每⽇的工作,同时管理者也可以通过统计报表随时掌握团队状况。ProWork 摒弃了僵化的流程,通过灵活轻量的任务管理体系,满足不同团队的实际情况,目前 ProWork 所有功能均可免费使用。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档