mirror of
https://github.com/foo-dogsquared/wiki.git
synced 2025-01-31 04:58:21 +00:00
aea7015cd5
Apparently, the convention (at least starting from 2018) is to make the keywords and block names to be in lowercase as stated from one of the following discussions at https://orgmode.org/list/87tuuw3n15.fsf@nicolasgoaziou.fr/. The files was updated with a one liner of shell. However, this is Emacs and org-mode does have an API to let you do stuff in your config and interact with the documents internally so it is not an elegant solution in any way.
23 lines
1022 B
Org Mode
23 lines
1022 B
Org Mode
#+title: Writing clean code
|
|
#+author: "Gabriel Arazas"
|
|
#+email: "foo.dogsquared@gmail.com"
|
|
#+date: "2020-06-19 20:30:23 +08:00"
|
|
#+date_modified: "2020-09-09 05:19:39 +08:00"
|
|
#+language: en
|
|
#+options: toc:t
|
|
#+property: header-args :exports both
|
|
|
|
|
|
Code should be readable, simple, and concise.
|
|
There are a few things to consider when writing code.
|
|
|
|
- When naming stuff like variables and functions, be clear and concise.
|
|
Furthermore, if applicable, imply its type.
|
|
For example, when the variable holds an array, you can append ~_list~ to its name (e.g., ~grade_list~ vs ~grades~).
|
|
If it's a boolean, you can prepend the name with ~is_~ or ~has_~.
|
|
|
|
- Use whitespace properly and consistently.
|
|
For example, in Python, spaces are preferred to tabs and a "tab" is made up of 4 spaces following [[https://www.python.org/dev/peps/pep-0008/][PEP 8 standard]] which is a style guide for Python.
|
|
|
|
This could be inapplicable if you're worrying about how to create the code that works so be sure to apply it when refactoring.
|