What is the best way to make a module easy to read

D0RYU · June 9, 2021, 2:49am

I have made two open sourced modules before and since I am working on a third one I want to make it easier to read, so people can use it easily.

if you have any suggestions that would be very helpful

superbolt999 · June 9, 2021, 2:51am

I have two resources that I use:
Lua Conventions:
https://roblox.github.io/lua-style-guide/
Clean Code:

gist.github.com

https://gist.github.com/evaera/fee751d4e228dd262fe1174ba142a719

Clean Code.md

1. Use descriptive and obvious names.
    - Don't use abbreviations, use full English words. `player` is better than `plr`.
    - Name things as directly as possible. `wasCalled` is better than `hasBeenCalled`. `notify` is better than `doNotification`.
    - Name booleans as if they are yes or no questions. `isFirstRun` is better than `firstRun`.
    - Name functions using verb forms: `increment` is better than `plusOne`. `unzip` is better than `filesFromZip`.
    - Name event handlers to express when they run. `onClick` is better than `click`.
    - Put statements and expressions in positive form.
        - `isFlying` instead of `isNotFlying`. `late` intead of `notOnTime`.
        - Lead with positive conditionals. Avoid `if not something then ... else ... end`.
        - If we only care about the inverse of a variable, turn it into a positive name. `missingValue` instead of `not hasValue`.

This file has been truncated. show original

Hope these help!

D0RYU · June 9, 2021, 3:03am

I think these are great
I pretty much already follow most of these rules

Only problem is when the module scripts get too long.
One of my modules has 58 functions so it makes it longer and harder to read.
Would I separate functions into different module scripts if it got long like that?

superbolt999 · June 9, 2021, 3:07am

I would separate it into a couple of modules and you can also put the modules into folders. You can also sort the modules into different functions inside that is related with each other functions of one module. Other then that I don’t know what more to organize it with.

D0RYU · June 9, 2021, 3:09am

yea I think I have a good idea on how to rework that now
thanks
loved the roblox style link btw