小C今天又来找我了,一脸不开心的样子,我心想不是刚被开除,不会这么快又被开除了吧。
小C对我说:下周马上要入职新公司了。
我:好事啊,怎么一脸不开心的。
小C:马上要入职新公司了,害怕自己的代码质量不过关,害怕被开除,特别是代码规范这块。
我:这个没事,你代码拿过来我看看。
小C给我一段,他写的代码:
public class ToolHelper
{
public int GetTwoNumberOfAverage(int ll, int l1)
{
int total = ll + l1;
return total / 2;
}
public int getAge(DateTime date)
{
return DateTime.Now.Year - date.Year;
}
}
我:这个代码是什么功能?
小C:这是我写的一个工具类,函数GetTwoNumberOfAverage是用来获取2个数字的平均数,函数getAge是用来获取年龄的。
我内心咯噔一下,心想还好,你先给我看了,不然下周肯定被开除,我给他耐心的讲解,他代码犯的几个错误:
1、GetTwoNumberOfAverage名字太长了,我们变量命名要言简意赅,可以改为GetAverage;
2、GetTwoNumberOfAverage这个函数的参数,命名也要规范,ll与l1,名字太类似了,我都不知道哪个是哪个。
3、getAge这个方法首字母要大写,命名规范要统一。
我们可以把代码改为如下:
public class ToolHelper
{
public int GetAverage(int number1, int number2)
{
int total = number1 + number2;
return total / 2;
}
public int GetAge(DateTime date)
{
return DateTime.Now.Year - date.Year;
}
}
小C:哦,这样啊,没想到代码规范,还这么多细节,你能和我说说代码规范吗?
我:可以,其实C#规范,微软官方已经讲得非常清楚了。
**代码规范要实现目标:保证在项目、团队、组织或公司源代码中实现一致性和可读性。**好的代码规范,不仅方便自己阅读,更重要的是便于团队协作,以及后期更新和维护。
具体代码规范,你可以看微软官方的文档:
https://learn.microsoft.com/zh-cn/dotnet/csharp/fundamentals/coding-style/coding-conventions
小C:除了看这个文档,还有没有其他方法啊。
我:当然有了,阅读开源项目,也是一份非常好的方法,微软非常多的开源项目,你任意去下载一个,阅读里面的代码就行。
小C:可是我看不懂里面的代码,怎么办。
我:这个不重要,你只要看代码规范就可以,比如文件名、类名、函数、变量、注释、空间名称等等,微软官方是怎么写的,就可以了。
Github地址:https://github.com/dotnet
小C:好的,我去看看。
我看小C压力非常大,马上又安慰他,其实你也没必要太担心,你入职公司后,公司的流程一般是这样的:
1、培训:新成员加入,公司都会安排培训的,每一家公司培训形式和时长不固定,但都会给你介绍,他们公司的编程规范、编程约定。
2、老带新:对于新成员,一般都会安排老成员与你对接,不懂的可以问他,态度要好,另外碰到问题要自己先思考,或者先搜索引擎寻找答案,不能一碰到问题就马上问,这个要切记。
3、参与开发:一开始给你,安排的任务,都是一些比较简单的,给你有足够的时间开发,所以尽量保证高质量完成,及时的汇报进度,碰到困难再求助。
小C:听你这么说,我就放心了;对于我这种新手程序员刚入职,公司一般会关注我哪些点?
我:刚开始你的很多能力,都是无法马上看出来的,一般也就看中你两个点:逻辑能力和代码规范,代码规范是一个程序员的基本功,程序员不能只注重逻辑能力。
小C:好的,我明白了,我去加强下基本功。
大家说,小C入职能成功吗?
小C系列:
就因一行代码,被开除
- End -
推荐阅读
用C#自己动手写个操作系统,爽!
盘点6个.NetCore+Vue前后端分离的开源项目
一个C#开发的Windows远程桌面工具
盘点10个Web开发人员必备的最佳开发工具推荐
程序员修炼内功:10篇文章汇总