Skip to content

Latest commit

 

History

History
164 lines (125 loc) · 3.18 KB

Coding Conventions.md

File metadata and controls

164 lines (125 loc) · 3.18 KB
Raw

Coding Conventions

It’s getting way too difficult to keep track of all this in my mind, so I need somewhere to standardardise it for consistency.


Aspects

Indentation

I’ve always preferred 2-space indentation. It’s far more subtle and elegant than 4-space. That being said, it does get out of hand when the nesting gets really deep – but if that happens, maybe the code needs refactoring.

The only exception (heh) is C#, which made me start using 4-space identation. I’m not entirely sure why exactly, but it just looks clearer. Maybe it’s the long lines C# tends to entail or the braces-on-their-own line structure.

And of course supcode throws that all out the window with 3-space indentation ;P

language spaces
Python 2
C# 4
HTML 2
CSS 2
JavaScript 2
SQL 2
JSON 2
YAML 2
supcode 3

Reference

Python

'''
project
version
'''

class PascalCase:
  '''A docstring.'''

  ## SPACE CAPS ##
  SNAKE_CAPS: const

  ## SPACE CAPS ##
  def snake_case(snake_case: param = default) -> type:
    '''Write a docstring.'''

    snake_case: var

    return snake_case

  @ snake_case
  def snake_case(
    snake_case: param = default,
    snake_case: param = default,
  ) -> type:
    '''Write a docstring.

    | parameter | type | notes |
    | :-------- | :--- | :---- |
    | `snake_case` | `type` / `tuple, tuple` / `generic[type]` | Sentence. |
    '''

    if (
      cond and
      cond
    ):
      for each in _:
        snake_case(snake_case = snake_case)

C#

/// project
/// version
/// by Sup#2.0 (@Sup2point0)
/// Last updated: date
/// Available at: <https://github.com/Sup2point0/project>

/// A docstring.
class PascalCase
{
    #region SPACE CAPS

    const PascalCase;

    #endregion

    #region SPACE CAPS

    /// Writes a docstring.
    void PascalCase(param camelCase = default)
    {
        var camelCase;
    }

    /// Writes a docstring.
    [PascalCase]
    void PascalCase(
        param camelCase = default,
        param camelCase = default
    )
    {
        if (
            cond &&
            cond
        ) {
            for {
                PascalCase(camelCase: arg);
            }
        }
    }

    #endregion
}

Unity

entity case instance notes
folder PascalCase Scripts/
file kebab-case game-executive.cs
editor object Title Case Game Executive
script component PascalCase GameExec
prefab field camelCasePrefab objectPrefab
term instance notes
Executive Exec GameExec AudioExec Manages a particular feature or aspect.
Spawner Origin ParticleSpawner Purely handles creation of objects. Often upgraded into an Executive.

supcode

kebab-case/
  kebab-case.sc

kebab-case

struct Kebab-Pascal {
   func kebab-case(par kebab-case) {
      class kebab-case {
         set var kebab-case
      }
   }
}