Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion basics/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Dans cette section nous allons aborder les bases du langage pour écrire nos pro

# Objectif

Nous allons apprendre la [syntaxe](https://en.wikipedia.org/wiki/Java_syntax) de programmation Java et les bases communes à tous les langages de programmation.
Nous allons apprendre la [syntaxe](https://en.wikipedia.org/wiki/Java_syntax) de Java et les bases communes à tous les langages de programmation.

* [Commentaires](comments.md)
* [Variables](variables/variables.md)
Expand Down
27 changes: 17 additions & 10 deletions basics/comments.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Les commentaires

Les commentaires sont des lignes dans notre code qui vont être ignorée lors de la compilation et l'éxecution du programmes.
Ils nous permettent d'expliquer des parties de codes compliqués. Ils ont utiles pour nous et les autres développeurs.
Les commentaires sont des lignes dans notre code qui vont être ignorées lors de la compilation et l'exécution du programme.
Ils nous permettent d'expliquer des parties de codes compliquées. Ils sont utiles voir indispensables dès lors que l'on travaille en équipe, afin de faciliter la compréhension du code.

#### Regular comments

Il existe deux types de commentaires dits « **réguliers** » :
Il existe deux types de commentaires dits *réguliers* :
{% method -%}
Des **Single-line** :
**Sur une ligne** :
{% sample lang="java" -%}
```
// Ce commentaire ne couvre qu'une ligne et ignore tout ce qui se trouve jusqu'au prochain retour à la ligne.
```
{% endmethod %}

{% method -%}
#### Des blocs de commentaires :
**Sur plusieurs lignes** :
{% sample lang="java" -%}
```
/* Ce commentaire couvre tout ce qui
Expand All @@ -23,10 +24,9 @@ Des **Single-line** :
{% endmethod %}


#### La javadocs
#### La javadoc
{% method -%}
Un certain type de blocs de commentaires sont utilisés pour créer la **javadocs**. Pour faire simple, il s'agit de créer des pages html expliquant comment le code fonctionne. Nous reverrons cela plus tard.
En voici un exemple :
La javadoc sert directement à la compréhension du code, que ce soit via l'inspection au sein d'un IDE, ou alors via un site web. Celui ci est généré à partir des sources d'un projet. La javadoc est un bloc spécifique de commentaires, que l'on initie avec deux **.En voici un exemple :
{% sample lang="java" -%}
```java
/**
Expand All @@ -43,13 +43,20 @@ public static void main(String[] args) {

# Utiliser les commentaires
{% method -%}
Les commentaires s'utilisent n'importe où dans le code. Vous pouvez réaliser des choses comme cecis :
Les commentaires s'utilisent n'importe où dans le code :
{% sample lang="java" -%}
```java
package foo;

/*
* Ce commentaire est généralement appelé "header" du fichier.
*/
public class HelloWorld {

/**
* Affiche seulement "Hello World!" dans la console, car "Hi there!" est commenté.
*/
public static void main(String[] args) {
// Permet d'afficher Hello World ! dans la console et de ne pas éxecuter Hi there !.
System.out.println("Hello World !");
// System.out.println("Hi there !");

Expand Down