1. 简介
2. 什么是风格?
3. 代码的风格为什么如此重要?
4. 更少的工作,更多的文档?
5. 推荐的代码风格
6. 简单的文档
7. 输出风格
8. 结论
简介
让我们面对一下吧…如果您是一个资深的程序员,那么您总是在最后期限下工作并且您的最终目标是完成您设计的软件。如果您是个新手,您的努力是更多的研究、试验、当然还有错误和一心希望您的程序可以象打算的那样运行。不管怎样,当您的程序真的如愿以偿的运行时那种成功的感觉令人十分振奋,但更多的程序员发现能够用良好的风格生成程序内部代码时的那种自豪的感觉更棒。
如果您是程序设计小组的成员或者如果您还在书写学校分配的任务,那么您会有机会被要求遵守某些必须遵守的风格规则。 绝大多数的程序员考虑风格这件事就象一个10岁大的孩子看待就寝时间一样。但资深程序员和我所见过的小组领导及多年来使用许多风格的程序员都会试图向您传达良好的代码风格与您所得意的一些书写代码的技巧同样重要。在这篇文章中我将尝试包括一些输出风格的观点,这也许有助您的编程旅程。
更少的工作,更多的文档?
因此风格意味着要在代码的每一行加上注解,对吗?错。如果没有做对的话,注解也会变成一场灾难。 我仍然希望一个程序员学会喜欢输入注解或真正对注解有足够的重视。为了未来的可维护性必须强制自己正确的放置注解。所以怎么能够不使用注解?
显然对一个新手最困难的事是懂得什么是好的变量命名。让我们看看以下的代码。您能告诉我下面的代码是做什么的吗?
float __fastcall TExampleForm::CalcAverageGrade(void)
{
int y=0;
int i=0;
for (i; i<x; i++) {
y=y+g[i];
}
return float(y/x);
}
在上面的例子中,您能很轻易的告诉我y代表什么呢?x又是什么呢?这段代码也许需要一些注释来解释这些变量的代表意义及代码中发生了什么?应用以上的代码风格,看不出什么逻辑关系。现在让我们看看应用更好的代码风格以后,代码是何等模样?
float __fastcall TExampleForm::CalcAverageGrade(void)
{
int total=0;
for (int i=0; i<maxGrades; i++)
{
total+=Grades[i];
} //求所有成绩的和
return float(total/maxGrades);
} //计算平均成绩
在您除错时以上两段代码孰优孰劣,已不必多说。现在就让我们讨论一些能够让您的代码更具有可维护性的推荐风格吧。
推荐的代码风格
1. 使用有描述意义的变量名。