"La première phrase devrait se terminer par une période."

Java checkstyle confond et me déroute.

package pmain;

/**
 * Some text here.
 */

public class Main {

}

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

Pourquoi ne CheckStyle produire cet avertissement?

Pourrait le checkstyle config je suis nécessaires à l'utilisation de être cassé? Suis-je en train de faire quelque chose de mal? Est "un texte" pas de la première phrase? Est "." pas une période?

source d'informationauteur Klaabu

  1. 7

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

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

    Passerait.

  2. 5

    Viens de tester sur ma machine et en fait ne peut pas reproduire: je n'ai pas un message d'avertissement avec un point à la fin de la phrase. Mais une fois que je le supprimer (et d'exécuter checkstyle encore), la règle est déclenchée correctement et j'obtiens le message d'avertissement sur la /** ligne.

    La ligne vide après le commentaire n'est pas de faire une différence.

    Double-vérifier que la dot est vraiment un point et pas un autre caractère qui "semble" comme un point. Et assurez-vous que vous ré-exécuter checkstyle après que vous avez modifié le fichier. Il ne sera pas effectuer des contrôles automatiquement.

    Peut-être que quelqu'un a joué avec le checkstyle paramètres. En fait il y a deux propriétés qui contrôlent cette règle: checkFirstSentence qui est vrai ou 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 la propriété... 😉

    Lecture

  3. 3

    - Ce juste de me gênait. Pour supprimer cette ajouter:

    ...

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

    ...

    Et aussi, pour moi, je TOTALEMENT supprimé le SummaryJavadoc module.

    dans votre checkstyle.xml pour passer cette case à off.

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

  4. 1

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

  5. 0

    - Je utiliser 2 lignes pour éviter cet avertissement. Par exemple:

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