2016. január 15., péntek

JAuthorTagger

No, csak rávettem magam, hogy release-eljem a kis programomat. :D Szóval elkészültnek nyilvánítom a JAuthorTagger nevű kis eszközömet, amit in medias res jelleggel rögtön 1.1-es verziószámmal dobok a köztudatba.

A program célja az, hogy a javadoc-ba írandó @author címkék projekt szintű kezelését biztosítsa. Hogyan is néz ez ki a gyakorlatban?


  1. Definiálsz egy ".authors" fájlt a projekted gyökerében, mondjuk valami ilyesmi tartalommal:
    $com.csomagod.neve.**
    +Te Neved
  2. Elindítod a JAuthorTagger-t megadva neki a projekt mappát:
    java -jar jauthortagger-1.1.0.jar /projekted/elérési/útja
  3. A cucc ekkor végigszánt az src mappában levő .java fájlokon; megnézi, milyen szerzők vannak benne; a konfig alapján módosítja őket; a végén pedig kiköp egy ".authors-diff-report.html" fájlt, amiben ellenőrizheted, mit módosított a fájljaidban.
  4. Ha valami nem tetszik, csak nyugi, a program csinált backupot a belebarmolás előtt, így állíthatod vissza az előző állapotot:
    java -jar jauthortagger-1.1.0.jar /projekted/elérési/útja restore
  5. Ha meg jónak tűnik az eredmény, véglegesítheted, azaz törölheted a backupot így:
    java -jar jauthortagger-1.1.0.jar /projekted/elérési/útja nobackup


A helyes működés előfeltétele az, hogy a forrásfájlok legyenek szokványosan formázottak - részleteket ld. readme -, legfontosabb talán az, hogy az author címkék így nézzenek ki a fájlokban:
" * @author Név", tehát szóközzel indítson a sor.

A konfig fájlban egy vagon lehetőség rejlik még: lehet törölni szerzőket regex alapján, lehet skippelni osztályokat; illetve fordítottan is meg lehet adni a dolgokat, nem osztályokhoz a szerzőket, hanem szerzőkhöz az osztályokat - kinek mi a kényelmesebb. :)

Nagyjából szerintem ennyit szerettem volna róla mondani, vegyétek-vigyétek, ötletek welcome! :)

P.S. Hajj, most, ahogy formáztam ezt a posztot, egyre inkább ingerenciám van Markdown-ra váltani, hatalmas találmány. :D

Nincsenek megjegyzések: