web-dev-qa-db-fra.com

"La première phrase devrait se terminer par un point."

Le checkstyle de Java me confond et me déconcerte.

package pmain;

/**
 * Some text here.
 */

public class Main {

}

C'est littéralement tout le code que j'ai. Checkstyle affiche le message "La première phrase doit se terminer par un point". au "/**".

Pourquoi CheckStyle génère-t-il cet avertissement?

La configuration de checkstyle que je dois utiliser peut-elle être cassée? Est-ce que je fais quelque chose de mal? Est-ce que "Du texte ici" n'est pas la première phrase? Est "." pas une période?

javacheckstyle
13
Klaabu

La première phrase devrait se terminer par un point.

/**
 *An abstract class that represents an algorithm.
 *
 * @author zhangtj
 *
 * @version 1.0
*/

Passerait.

9
Jimmy Zhang

Vient de tester sur ma machine et ne peut pas reproduire réellement: je ne reçois pas d'avertissement avec un point à la fin de la phrase. Mais une fois que je l'enlève (et relance checkstyle), la règle est déclenchée correctement et j'obtiens l'avertissement sur la ligne /**.

La ligne vide après le commentaire ne fait aucune différence.

Vérifiez que le point est vraiment un point et pas un autre caractère qui "ressemble" à un point. Et vérifiez que vous relancez vraiment checkstyle après avoir modifié le fichier. Les vérifications ne seront pas effectuées automatiquement.

Peut-être que quelqu'un a joué avec les paramètres de checkstyle. En fait, deux propriétés contrôlent cette règle: checkFirstSentence, qui est soit vrai, soit faux, et endOfSentenceFormat, qui est une expression régulière et doit correspondre à la période. Mais si le jeu de règles a redéfini cette propriété ...;)

Lectures complémentaires

6
Andreas_D

Cela m'a juste agacé. Pour supprimer ceci, ajoutez:

...

<module name="JavadocStyle">
   <property name="checkFirstSentence" value="false"/>
</module>

...

Et aussi, pour moi, j'aiTOTALEMENTsupprimé le module SummaryJavadoc.

dans votre checkstyle.xml pour désactiver cette coche.

Voir: http://checkstyle.sourceforge.net/config_javadoc.html#JavadocStyle & http://checkstyle.sourceforge.net/config_javadoc.html#SummaryJavadoc

4
theINtoy

Thin peut être causé par un espace après la fin du commentaire ou par un '.'

2
aarathi

J'utilise 2 lignes pour éviter cet avertissement. Par exemple:

/**
 * Let's call this as the first sentence,
 * here the second one.
*/
0
EgorTitov