Blue style coding conventions

MRC-CSO-SPHSU / UKSEABMLib.jl

MIT License

1 stars 1 forks source link

Blue style coding conventions #34

Closed AtiyahElsheikh closed 1 year ago

AtiyahElsheikh commented 1 year ago

This seems to a recognized coding guideline from the Julia community. The purpose is not to follow all conventions up to the tiniest details. But It is good to follow something and stick with it. Some points to follow:

Functions that are only intended for internal use should be marked with a leading underscore (e.g., _internal_utility_function(X, y))
Names of functions should usually be limited to one or two lowercase words separated by underscore

AtiyahElsheikh commented 1 year ago

Try to adhere to a 92 character line length limit.

VSCode Settings

{
    "[julia]": {
        "editor.detectIndentation": false,
        "editor.insertSpaces": true,
        "editor.tabSize": 4,
        "files.insertFinalNewline": true,
        "files.trimFinalNewlines": true,
        "files.trimTrailingWhitespace": true,
        "editor.rulers": [92],
    },
}