Aqua's Luau Style Guide: Promotes Consistency and Readability

Resources Community Resources
#1

Hey everyone! I would like to share my coding style guide. Its purpose is to make your code more consistent and readable.

This guide is not claiming to be the one answer to how to code. It’s highly opinionated and you can disagree with the guide’s practices. So take from it what you will. Use this as a guideline or completely as is, or don’t, it’s completely up to you!

Feel free to reach out or ask questions either here or discord at @aquamizu!

THIS IS NOT THE OFFICAL ROBLOX OR LUA GUIDE!

This guide supports optional use of both type checking and frameworks.

You can access the style guide by clicking here or the image below.

Style Guide Image

11 Likes
#2

i became blind after reading this

i need dark mode please

#3

There are some really good tidbits in this guide. Thank you for your contribution.

#4

Sadly the site I posted it on doesn’t have it :frowning:. You can install a darkmode extension if needed though.

1 Like
#5

unfortunately, I use the Roblox Player to use the developer forum, and can’t use extensions

#6

:pray: Thank you, this is my first semi-major contribution. Hopefully people use it well.

1 Like
#7

You can do that?!?! I never knew you could lol. Hopefully it isn’t too bad on your eyes. Imma ask the creator of hackMD to add dark mode, not sure if he’ll do it though.

1 Like
#8

Using parenthesis like that really seems like a good idea.

#9

Yea I’ve found it to be much easier to read in the few cases where a one line evaluation that long proved beneficial.

#10

I changed it to dark theme now so no more eye pain :slight_smile:

1 Like