Les commentaires

Le plus simple

Les commentaires permettent de documenter son code. Il aide :

• Une relecture plus facile de son code
• Après un moment sans avoir vu le code, il permet de comprendre plus facilement le cheminement
• Une compréhension plus simple quand on partage son code sur internet
• …

Il est préférable que les commentaires soient écrits en anglais surtout si vous partagez votre code avec la terre entière sur une plateforme dédiée.

Ne pas en mettre est une très grosse erreur sur le long terme.

Ceci est un commentaire :

1

-- Je suis un commentaire

Un autre commentaire :

1
2

-- print(5) Cette ligne ne sera jamais "lue"
print(10)

Si j’exécute le code, les commentaires n’apparaissent pas. Ils ne sont pas lu par l’interpréteur lua.

1
2
3

$ lua commentaire.lua

10

Les autres formes

Maintenant que je vous ai présenté la forme la plus utilisé, voyons le reste.

Commençons avec les commentaires de bloc :

1
2
3
4
5
6

--[[
  Ceci est un commentaire de bloc car il s'étale sur 1 ligne et plus.
  Nous pouvons aller à la ligne …
  une autre ligne …
  et encore une autre …
]]

Beaucoup moins intuitif :

 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 [[

Dans le même style, vous avez :

1
2
3
4

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

Voici les 2 dernières possibilités. C’est assez particulier, j’en conviens

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")
--]=]