style - mathieu-bergeron/aquiletour2021 GitHub Wiki

Guide de style, projet aquiletour2021

Français ou anglais?

  1. En anglais: le code, les commentaires dans le code
  2. Le reste en français

Commentaire ou renommage?

  1. Avant d'écrire un commentaire, j'essaie de rendre le commentaire inutile:

    • en changeant le nom de variable
    • en créant une variable avec un nom significatif
    • en créant une méthode avec un nom significatif

  2. Ne pas écrire un commentaire qui décrit la même chose que le code!:

⚠️ **GitHub.com Fallback** ⚠️