Skip to content

Commit ec50165

Browse files
author
vmaubert
authored
fix some typos
1 parent 5ec0a54 commit ec50165

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

site/content/blog/2016-10-03-android-annotations-lib.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ url: /2016/10/03/android-annotations-lib/
1212
aliases: /2016/10/03/android-annotations-lib.html
1313
---
1414

15-
Dans le lot des https://developer.android.com/topic/libraries/support-library/index.html[supports librairies] que propose Google pour le développement Android (principalement pour la compatibilité des certains composants sur des anciennes versions de l'OS) il y en a une qui de prime abord ne va pas beaucoup servir c'est `support-annotations`.
15+
Dans le lot des https://developer.android.com/topic/libraries/support-library/index.html[supports librairies] que propose Google pour le développement Android (principalement pour la compatibilité de certains composants sur des anciennes versions de l'OS) il y en a une qui de prime abord ne va pas beaucoup servir c'est `support-annotations`.
1616

1717
[%hardbreaks]
1818

1919
En effet cette librairie ne contient pas grand chose en terme de classes ni de http://www.methodscount.com/?lib=com.android.support%3Asupport-annotations%3A24.2.1[méthodes]. En revanche elle possède de nombreuses annotations (d'où son nom...). Le comble c'est que presque toutes ces annotations sont définie en tant que `@Retention(CLASS)`, c'est-à-dire qu'elles seront conservées lors la génération des fichiers _.classes_ mais n'auront pas d'impact au moment de l'execution du code`.
20-
À quoi peuvent-elles servir ? Et bien c'est le propre des annotations, elles servent à apporter des informations sur des portions de code et éventuellement donner quelques instructions au compilateur. L'un des exemples le plus connu est _@Deprecated_ que vous devez cotoyer tous les jours. Cette annotation a pour seul but d'informer le développeur qu'il est fortement déconseillé d'utilser cette méthode.
20+
À quoi peuvent-elles servir ? Et bien c'est le propre des annotations, elles servent à apporter des informations sur des portions de code et éventuellement donner quelques instructions au compilateur. L'un des exemples le plus connu est _@Deprecated_ que vous devez cotoyer tous les jours. Cette annotation a pour seul but d'informer le développeur qu'il est fortement déconseillé d'utiliser cette méthode.
2121

22-
L'avantage d'utiliser les `support-annotations` est qu'Android Studio connait leur signification et donc vas pouvoir highlighter des portions de code en rapport avec celles-ci lorsqu'un comportement attendu n'est pas respecté.
22+
L'avantage d'utiliser les `support-annotations` est qu'Android Studio connait leur signification et donc va pouvoir highlighter des portions de code en rapport avec celles-ci lorsqu'un comportement attendu n'est pas respecté.
2323

2424
Faisons un petit tour des https://developer.android.com/reference/android/support/annotation/package-summary.html[annotations présentes dans `support-annotations`] et de leur intégration dans Android Studio
2525

2626

2727
# @Nullable / @NonNull
2828

29-
Le couple d'annotation le plus connu est probablement @Nullable et @NonNull, car déjà présent depuis un certain temps dans différents packages comme https://www.jetbrains.com/help/idea/2016.2/nullable-and-notnull-annotations.html[Intellij] ou http://mvnrepository.com/artifact/javax.annotation/javax.annotation-api/1.3[javax.annotations].
29+
Le couple d'annotations le plus connu est probablement @Nullable et @NonNull, car déjà présent depuis un certain temps dans différents packages comme https://www.jetbrains.com/help/idea/2016.2/nullable-and-notnull-annotations.html[Intellij] ou http://mvnrepository.com/artifact/javax.annotation/javax.annotation-api/1.3[javax.annotations].
3030

3131
Annoter une méthode @Nullable permet d'indiquer que le retour de celle-ci peut être _null_ et donc qu'il est fort préférable de procéder à un null check avant d'utiliser l'objet retourné. Le @NonNull permet lui d'assurer que le résultat est toujours un objet valide.
3232

@@ -43,10 +43,10 @@ Annoter une méthode @Nullable permet d'indiquer que le retour de celle-ci peut
4343

4444
# @<Any>Res
4545

46-
Le groupe d'annotation suivant est probablement celui que j'utilise le plus souvent est le `@...Res`.
46+
Le groupe d'annotations suivant est probablement celui que j'utilise le plus souvent est le `@...Res`.
4747

4848
Et oui étant donné que toutes les références des ressources sont des `int` lorsqu'elles sont générées dans votre class _R_ il est difficile de les différencier lorsqu'on en passe une en paramètre de méthode.
49-
Et bien avec un `@ColorRes int myColor`, Android studio s'occupera de vous avertir si la valeur passée ne correspond pas à une ressource du type `color`.
49+
Et bien avec un `@ColorRes int myColor`, Android Studio s'occupera de vous avertir si la valeur passée ne correspond pas à une ressource du type `color`.
5050

5151
{lt}div style="text-align : center"{gt}
5252
{lt}a class="inlineBoxes" href="/images/posts/2016-09_AndroidAnnotations/android_annotations_stringres.png" data-lightbox="1" title="Warning sur un paramètre @StringRes"{gt}
@@ -65,7 +65,7 @@ La liste (non complète) des ressources que vous pouvez contrôler :
6565
- `StringRes`
6666

6767
# @CallSuper
68-
Je l'ai découverte récement et je trouve qu'elle est d'une grande aide. Étant donné l'importance du cycle de vie de chaque élément dans Android
68+
Je l'ai découverte récemment et je trouve qu'elle est d'une grande aide. Étant donné l'importance du cycle de vie de chaque élément dans Android
6969
il est indispensble de s'assurer que chaque méthode est appelée au bon moment.
7070
Et lorsque qu'il y a un peu de refactor il arrive vite d'oublier d'appeler le super d'une méthode surchargée. Maintenant vous en serez averti !
7171

@@ -81,7 +81,7 @@ Et lorsque qu'il y a un peu de refactor il arrive vite d'oublier d'appeler le su
8181
# @RequirePermission
8282
Pour être sur de ne pas oublier une permission dans le `manifest.xml` cette annotation permettra (sur une classe ou une méthode) de vous rappeler explicitement quelles sont celles dont vous avez besoin.
8383

84-
On peut d'ailleurs voir le warning d'android studio en créant un sample project et en démarrant une nouvelle activity avec un `Intent.ACTION_CALL`.
84+
On peut d'ailleurs voir le warning d'Android Studio en créant un sample project et en démarrant une nouvelle activity avec un `Intent.ACTION_CALL`.
8585

8686

8787
{lt}div style="text-align : center"{gt}
@@ -93,8 +93,8 @@ On peut d'ailleurs voir le warning d'android studio en créant un sample project
9393
{lt}br/{gt}
9494

9595
# @StringDef
96-
Lorsque l'on dev pour Android on doit savoir que https://www.youtube.com/watch?v=Hzs6OBcvNQE[les enums sont a proscrire] et du coup c'est embetant, car c'est tout de même bien pratique.
97-
La parade est donc de passer par une liste de constantes et de créer une nouvelle annotation qui limitera les valeurs attendu, comme ceci :
96+
Lorsque l'on dev pour Android on doit savoir que https://www.youtube.com/watch?v=Hzs6OBcvNQE[les enums sont à proscrire] et du coup c'est embêtant, car c'est tout de même bien pratique.
97+
La parade est donc de passer par une liste de constantes et de créer une nouvelle annotation qui limitera les valeurs attendues, comme ceci :
9898

9999
[source,java]
100100
-----
@@ -112,7 +112,7 @@ public @interface Trooper {
112112
}
113113
-----
114114

115-
Et ensuite d'uiliser cette annotation a chaque fois que seulement une des valeurs précédent est autorisée.
115+
Et ensuite d'utiliser cette annotation à chaque fois que seulement une des valeurs précédente est autorisée.
116116

117117
[source,java]
118118
-----
@@ -147,7 +147,7 @@ Une variante `@FloatRange` est aussi disponible.
147147
# Lint
148148

149149
Comme chacune des erreurs n'empèche pas la compilation du projet, un bon moyen de surveiller qu'il n'y a pas de violation aux règles mises en place grâce à toutes ces annotations,
150-
est de controler les rapports générés par lint
150+
est de contrôler les rapports générés par lint
151151

152152
{lt}div style="text-align : center"{gt}
153153
{lt}a class="inlineBoxes" href="/images/posts/2016-09_AndroidAnnotations/android_annotations_lint.png" data-lightbox="1" title="Exemple de rapport lint"{gt}

0 commit comments

Comments
 (0)