计算 c++ 代码中的特定内容

Question

谁能帮助我使这个更通用、更专业？

#include <fstream>
#include <iostream>
#include <string>
#include <vector>

using namespace std;


int main()
{
 // open text file for input: 

 string file_name;

 cout << "please enter file name: ";
 cin  >> file_name;

 // associate the input file stream with a text file

 ifstream infile(file_name.c_str());

 // error checking for a valid filename

 if ( !infile )
    {
  cerr << "Unable to open file "
    << file_name << " -- quitting!\n";
  return( -1 );
    }
  else cout << "\n";

 // some data structures to perform the function

 vector<string> lines_of_text;
 string textline;

 // read in text file, line by 

 while (getline( infile, textline, '\n' ))
 {
  // add the new element to the vector

  lines_of_text.push_back( textline );

  // print the 'back' vector element - see the STL documentation

  cout << lines_of_text.back() << "\n";
 }

 cout<<"OUTPUT BEGINS HERE:  "<<endl<<endl;
cout<<"the total capacity of vector: lines_of_text is: "<<lines_of_text.capacity()<<endl;

int PLOC = (lines_of_text.size()+1);
int numbComments =0;
int numbClasses =0;

cout<<"\nThe total number of physical lines of code is: "<<PLOC<<endl;


for (int i=0; i<(PLOC-1); i++)

//reads through each part of the vector string line-by-line and triggers if the 

//it registers the "//" which will output a number lower than 100 (since no line is 100 char long and if the function does not 
//register that character within the string, it outputs a public status constant that is found in the class string and has a huge value
//alot more than 100.


{
string temp(lines_of_text [i]);
if (temp.find("//")<100)
numbComments +=1;
}
cout<<"The total number of comment lines is: "<<numbComments<<endl;

for (int j=0; j<(PLOC-1); j++)
{
string temp(lines_of_text [j]);
if (temp.find("};")<100)
numbClasses +=1;
}
cout<<"The total number of classes is: "<<numbClasses<<endl;

Answer 1

正确格式化代码，使用一致的风格和术语，并扔掉完全多余的注释和空行。生成的代码应该没问题。或“专业”。

在这里，我采取了努力（以及一些纯粹主观的风格上的东西）：

请注意，输出实际上是错误的（只需在程序代码本身上运行它即可看到......）。

#include <fstream>
#include <iostream>
#include <string>
#include <vector>

using namespace std;

int main()
{
    string file_name;

    cout << "please enter file name: ";
    cin  >> file_name;

    ifstream infile(file_name.c_str());

    if (not infile) {
        cerr << "Unable to open file " << file_name << " -- quitting!" << endl;
        return -1;
    }
    else cout << endl;

    vector<string> lines_of_text;
    string textline;

    while (getline(infile, textline)) {
        lines_of_text.push_back(textline);
        cout << lines_of_text.back() << endl;
    }

    cout << "OUTPUT BEGINS HERE:  " << endl << endl;
    cout << "the total capacity of vector: lines_of_text is: "
         << lines_of_text.capacity() << endl << endl;

    int ploc = lines_of_text.size() + 1;

    cout << "The total number of physical lines of code is: " << ploc << endl;

    // Look for comments `//` and count them.
    int num_comments = 0;
    for (vector<string>::iterator i = lines_of_text.begin();
            i != lines_of_text.end();
            ++i) {
        if (i->find("//") != string::npos)
            ++num_comments;
    }

    cout << "The total number of comment lines is: " << num_comments << endl;

    // Same for number of classes ...
}

Answer 2

我不太确定您在问什么，但我可以指出此代码中可以改进的一些内容。我将重点关注实际陈述，并将风格评论留给其他人。

• cin>>文件名;
  要处理带空格的文件名，最好这样写
  getline(cin, file_name);

• int PLOC = (lines_of_text.size()+1);
  为什么你声称比实际多了一行？

• if (temp.find("//")<100)
  有一些复杂的评论解释了这一点。写得更好
  if (temp.find("//")
在所有行长度上都能正常工作。

• cout<<"注释行总数为："<
实际上，您计算了行尾评论的数量。我不会将语句末尾的注释称为“注释行”。

• 您不计算 /* */ 风格的注释。

• 将类的数量计算为};？真的吗？ struct、enum 和简单的多余分号怎么样？只需计算 class 关键字出现的次数即可。它的两侧不应有字母数字字符或下划线。

Answer 3

1. 使用正确的缩进，您的代码在当前形式下很难阅读。 这里是样式列表。
2. 尽可能使用 ++variable 而不是 variable += 1； ++ 运算符的存在是有原因的。
3. 保持编码风格的一致性。如果您要在 cout 和 << 等内容之间留出空格，则函数参数和函数括号会这样做，否则不会，但要保持一致。为您的变量选择一种命名约定并坚持使用。您可以在 Google 上找到很多有关样式的信息，例如此处和此处。
4. 不要使用整个 std 命名空间，仅使用您需要的部分。用户可以using std::cout; 或在所有cout 语句前加上std::
5. 避免不必要的注释。每个人都知道 ifstream infile(file_name.c_str()); 的作用，例如，我不知道你的程序作为一个整体做了什么，因为我不太关心理解它的作用由于缩进而发生。这是一个简短的程序，因此与其单独解释每个语句，为什么不解释该程序的目的是什么以及如何使用它呢？

这些都是风格点。假设您的目标是计算评论和类，您的程序无法以其当前形式运行。这样做比你想象的要困难得多。如果我有一个“};”怎么办？例如作为字符串的一部分？如果我在字符串中有注释怎么办？

Answer 4

不要导入整个 std 命名空间，仅导入您需要的内容：

using std::string;

使用一致的命名约定：决定您更喜欢 name_for_a_variable 还是 nameforavariable或nameForAVariable。并使用有意义的名称：numbComments 让我联想到与 numberOfComments、numComments 或 commentCount 截然不同的事物。

如果您的原始代码如下所示，我强烈建议您选择单一一致的缩进样式：要么在同

if ( ... )
    {
    ...
    }

一个源文件中，要么

if ( ... )
{
    ...
}

在同一个源文件中不两者。

还要删除无用的注释，例如

// add the new element to the vector

This is “only” 关于代码的可读性，甚至没有触及其功能...（正如其他人已经指出的那样，这是不正确的）。请注意，任何一段代码都可能被读取的次数多于编辑的次数。我相当确定，如果您需要在几个月后阅读（并理解）您自己的这种形式的代码，您将遇到困难。

Answer 5

“更专业”并不是根本不做。使用现有的 SLOC 计数器，这样您就不必重新发明轮子。

此讨论列出了一些：
http://discuss.techinterview.org/default.asp?joel.3.207012。 14

另一个提示：不要使用 "temp.find("};}) < 100)"，使用 "temp.find("};") != temp.npos;"

编辑：s/end()/npos。呃。