这个函数是否声明得很好



这是我的第一个问题。我真的是编程新手,在从WTF codemonkey代码中辨别结构良好的代码时,我正在努力。在创建这个简单的程序时,我应该做些什么不同的事情吗?我主要关心的是功能。

        #include <iostream>
        using namespace std;
        void enter_numbers ( int & iNum1, int & iNum2 ) {
        cout << "Enter first number" << endl;
        cin >> iNum1;
        cout << "Enter second number" << endl;
        cin  >> iNum2;
        }
        float calc_avg ( int iNum1, int iNum2){
            float fRes;
            fRes =(float)(iNum1 + iNum2)/2;
            return fRes;
        }
        void show_avg ( float fRes ) {
        cout << "Average is: " << fRes;
        }
        void main () {
        int iNum1;
        int iNum2;
        enter_numbers ( iNum1, iNum2);
        float fRes = calc_avg (iNum1, iNum2);
        show_avg ( fRes );
        fflush(stdin);
        getchar ();
       } 
  1. 您不应刷新输入流,如下所述:http://www.gidnetwork.com/b-57.html
  2. 您的 main 函数应该将 int 作为返回类型并返回 0,以便成功执行:main(( 应该在 C 和 C++ 中返回什么?

在休息时,您的代码似乎很好。请注意,对于初学者来说,您应该很高兴,它本来就很好。我刚刚提到了您可能想要进行的一些改进,并为进一步的文档指出了一些来源,因为我想您想了解更多信息。

每个企业文化 - 或任何其他共同处理代码的人 - 都会有一套编码风格指南,变量和函数命名约定,等等。 你会听到很多关于如何使代码可读的意见(可能很快=D(,以下问题大多是宗教性的:

  • 匈牙利符号(变量名称如lpctszName(与普通英语。 我的看法是,它是有时间和地点的。 查找"匈牙利语应用程序"与"匈牙利系统"。

  • 凹痕。 我们都同意(几乎是反对者?(复合语句的主体(例如函数定义(应该缩进。 所以这样做。 然而,关于大括号继续哪条线确实存在激烈的争论。 我喜欢行尾的开场白。 查找"一个真正的缩进样式"。

  • ReadableVariable vs readableVariable vs readable_variable等等。

底线是,像任何其他文本主体一样,代码也有受众。 是与您一起工作的人,或者接管代码维护的人,或者测试代码的人。 在个人项目中,就是你,几周后你不记得变量是什么。 您的编码风格应与受众所知道的一致。

除此之外,如果没有异常或编译时错误,你的代码是好的。 不过,在未来,工作代码会进入代码审查StackExchange,而概念问题则交给程序员StackExchange。 欢迎来到 StackOverflow =D。

只写num1num2res而不是iNum1iNum2fRes。该类型已作为声明的一部分可见。

相关内容

最新更新