Les commentaires

Le plus simple

Les commentaires permettent de documenter son code. Ils facilitent :

• Une relecture plus aisée de son propre code
• Une meilleure compréhension après une période sans avoir consulté le code
• Une clarté accrue lorsqu’on partage son code en ligne
• …

Il est recommandé d’écrire les commentaires en anglais, surtout si vous publiez votre code sur une plateforme accessible à l’international.

Ne pas commenter son code est une erreur fréquente qui se paie sur le long terme.

Voici un exemple de commentaire :

1

-- Je suis un commentaire

Un autre exemple :

1
2

-- print(5) Cette ligne ne sera jamais exécutée
print(10)

Si vous exécutez ce code, les commentaires ne s’affichent pas. Ils ne sont pas lus par l’interpréteur Lua.

1
2
3

$ lua commentaire.lua

10

Les autres formes

Maintenant que nous avons vu la forme la plus courante, explorons les autres.

Les commentaires de bloc

1
2
3
4
5
6

--[[
  Ceci est un commentaire de bloc, car il s'étale sur une ou plusieurs lignes.
  Nous pouvons aller à la ligne…
  Une autre ligne…
  Et encore une autre…
]]

Version avec délimiteurs personnalisés

Moins intuitif mais possible :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

--[=[
  Commentaire de bloc.
  Lui aussi est multilignes
--]=]

print('Je ne suis pas un commentaire')

--[==[
  Un autre commentaire de bloc
  et multilignes
--]==]

print('Je ne suis pas non plus un commentaire')

Vous pouvez mettre autant de = que vous le souhaitez entre les [[ et ]].

Une autre forme similaire :

1
2
3
4

--[[
  Je suis un commentaire de bloc
  donc je suis multilignes
--]]

Cas particuliers

Voici deux formes un peu plus spéciales :

1
2
3
4
5

---[[
  print("Lua c'est la vie")
--[=[]]
  print("Lua c'est la vie")
--]=]

1
2
3
4
5

--[[
  print('Lua c'est la vie')
--[=[]]
  print("Lua c'est la vie")
--]=]