Code Formatting
h
MrEconomical (1924)

why tho

One of the things I hate most about programming is messy code. For example:

seems legit

Indenting

Indenting is a big problem in some people's code, as seen in the example above. Bad indenting makes code look ugly and unreadable. The standard indent is 4 spaces, but if you can pick your own indent size (it's not that important of a convention anymore). The important thing to remember is to always be consistent with tab size and indent your code properly.

function myFunction() {
    // 1 indent inside of a function
    for (blah blah blah) {
        // 1 more indent whenever inside another layer of brackets basically
    }
}

Spacing

Spacing is how you put spaces in the code itself. Just as important as indenting is good and consistent spacing. Again, it's all up to you but I like to space my code like this:

a=b+c
a = b + c
// Space between operators to make it look nicer not cramped
function a() {
    // Space after closing parentheses and bracket
    // If you haven't noticed space after comments (commenting later)
}

Variable and Function Naming

A very important part of code formatting is how you name your variables and functions. It might not seem like a very big deal, but naming variables names that make sense often makes code easier to read and debug.

One common thing that people do is name all of their variables in for loops i. You don't actually need to name it i because it is just a normal variable. Name it whatever makes sense to the thing you are iterating through.

When picking a variable name, keep in mind the case you are using. There are two main ways to name variables, camelCase and snake_case. Everybody has their own preferences and I prefer naming my variables using snake_case. Pick a case, and stick to it throughout all of your code. Be consistent with your naming conventions.

Commenting

Not many people comment in code. I have no idea why, I do it all the time and it is very helpful. Commenting is important for easy-to-read code, whether you forgot how one part works or if somebody else is trying to understand your project. It also makes code look better imo

Always make your comments about what the code does and not how it works. Example:

// Bad
// Get end of file name split by "."
// Good
// Get file extension

Also always comment in the imperative tense, Get file extension and not Gets file extension.

Now since you have read this tutorial, you are a god at formatting good job

cough cough @AtticusKuhn cough cough

You are viewing a single comment. View All