21.6. Stosowanie narzędzia Checkstyle do definiowania reguł dla nagłówków w kodzie źródłowym

Wiele firm i projektów stosuje standardową konwencję nagłówków plików. Narzędzie Checkstyle oferuje wiele sposobów wymuszania tej konwencji. W najprostszych przypadkach w zupełności wystarczy napisanie szablonu nagłówka obejmującego zarówno stałe wiersze, jak i wiersze modyfikowane przez programistę. Przypuśćmy, że standardy obowiązujące w naszej firmie narzucają nam komentarze otoczone wierszami złożonymi z ukośników i wzmiankę o prawach autorskich w dolnej części każdego takiego bloku:

////////////////////////////////////////////////////////////////////
// Tytuł mojego projektu
// Tutaj powinien się znaleźć opis tego pliku.
//
// Copyright (C) 2006 Moja ...

Get Java. Praktyczne narzędzia now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.