Is my code clean enough? | Hashnode

Thread

Đăng Tú

I'm ME! Surprise!

Sep 20, 2018

Is my code clean enough?

I'm practicing writing C++ on HackerRank and try makin' a good, clean code. So, is my code clean enough?

#include <iostream>
#include <cstdio>
using namespace std;

string number [9]
{
    "one",
    "two",
    "three",
    "four",
    "five",
    "six",
    "seven",
    "eight",
    "nine"
};

int minN, maxN;

void checkN(int);


int main()
{
    cin >> minN >> maxN;
    for (int i = minN; i <= maxN; i++)
    {
        checkN(i);
    }

    return 0;
}


void checkN(int n)
{
    if (n >= 1 && n <=9)
        cout << number[n - 1] << endl;
    else if (n > 9)
        cout << ((n % 2 == 1) ? "odd" : "even") << endl;

}

If my code is clean, could you tell me what part is clean, vice versa for not-very-clean. Thanks in advance.

#cpp #clean-code #programming

Responses(4)

Mark

formerly known as M

Sep 21, 2018

I'm not great at C++, but two general opinions:

Possibly checkN could be named more clearly, because now one has to read the function to know what it does. Maybe printParity?
Always adding brackets around then/else blocks, even if they are single lines, may be overly verbose, but helps prevent problems.

Thanks a lot, I never thought the missing brackets would be so terrible.

Florian Mari

Sep 27, 2018

Đăng Tú I would recommand you something like this:

#include <iostream>
#include <cstdio>
using namespace std;

void printParity(int n)
{
    string number[9] =
    {
        "one",
        "two",
        "three",
        "four",
        "five",
        "six",
        "seven",
        "eight",
        "nine"
    };
    if (n >= 1 && n <=9)
        cout << number[n - 1] << endl;
    else if (n > 9)
        cout << ((n % 2 == 1) ? "odd" : "even") << endl;

}

void checkNumbers() {
    int minN, maxN;

    cin >> minN >> maxN;
    for (int i = minN; i <= maxN; i++)
    {
        printParity(i);
    }
}

int main()
{
    checkNumbers();
    return 0;
}

I don't know if this code compile but some recommendations about code clarity

Avoid using global declaration like for your number array, you just use it in your checkN function (same for the declaration of min and max N)
Try to not do some business logic in your main, keep it clean it's better
A hard thing in software engineering is naming, you should use explicit functions names!
Declare your functions BEFORE the main to avoid that kind of declaration void checkN(int);

ĐT

Đăng Tú

I'm ME! Surprise!

Sep 27, 2018

Thanks a lot. Your correction is really helpful. However, it leads me to a few curious. I hope you don't mind to teach me more.

I can see your code-flow is from detail to general (main is at the last). Is this the popular code style in C++?
You said I should define function before the main? I don't understand what's wrong with the declaration first and definition after?
Do you have any naming-tips for non-native speakers?

Hey!

1) Yes in general when you are working on one-file only program you set your main at the end, it's typical in C/C++ and in fact a lot of languages. If you're on a bigger program your main will be in a separate file.

2) We set main function at the end to avoid declare prototype in the code, here you add preprocessor treatment and it's useless, if main is at the end it does know what are your functions. A more correct way to declare prototype is to declare them in a header file and not in the cpp file

3) I don't, naming things in very hard but you have to follow one principle in software engineering, it's: separation of concerns. Each function must have one thing to do and not a lot of things. That means your code must be clean and cut! (I'm not a native english speaker)

Search Hashnode

Is my code clean enough?

Responses(4)

Recent threads