AKSW - projects/DLLearner/CodeStyle

2008-08-05 13:39:48

Comparison for /projects / DL Learner / Code Style of 2008-08-05 13:39:48 and 2008-08-13 10:30:38

Additions:

Open issues / Best Practice:

Delegate methods: Unfortunately, there seems to be no nice way to document delegate methods. The best thing to do at the moment seems to include a shortened version of the method we delegate to.
Convenience methods with incomplete parameters: Often, you have several convenience methods, e.g. method(int) may call method(int,String,int) by just using defaults for the last two parameters. There seems to be no nice way to document this. As best practice, the most complex method (including the actual implementation) should be documented in detail, whereas the other methods should include a copied or shortened version of the Javadoc.

Deletions:

Open issues:

2008-08-01 14:01:20

Comparison for /projects / DL Learner / Code Style of 2008-08-01 14:01:20 and 2008-08-05 13:39:48

Additions:

Update: Checkstyle 5.0beta solves the @Override problem (and possibly others specific Java 5 or higher). It is recommended to install it, instead of the previous version. To to this, go to https://sourceforge.net/project/showfiles.php?group_id=80344, download it and extract it in your source folder. (If you have a previous version of checkstyle, make sure you uninstalled it first.)
Differences between Checkstyle 4 and 5: In doc/checkstyle.xml you need to rename JavadocPackage to PackageHtml if you use Checkstyle 4.

Deletions:

Update: Checkstyle 5.0beta solves the @Override problem (and possibly others specific Java 5 or higher). It is recommended to install it, instead of the previous version. To to this, go to https://sourceforge.net/project/showfiles.php?group_id=80344, download it and extract it in your source folder. (If you have a previous version of checkstyle, make sure you uninstalled it first.) In doc/checkstyle.xml you need to rename PackageHtml to JavadocPackage.

2008-07-30 17:31:06

Comparison for /projects / DL Learner / Code Style of 2008-07-30 17:31:06 and 2008-08-01 14:01:20

Additions:

install the Eclipse checkstyle plugin – see the update below

Update: Checkstyle 5.0beta solves the @Override problem (and possibly others specific Java 5 or higher). It is recommended to install it, instead of the previous version. To to this, go to https://sourceforge.net/project/showfiles.php?group_id=80344, download it and extract it in your source folder. (If you have a previous version of checkstyle, make sure you uninstalled it first.) In doc/checkstyle.xml you need to rename PackageHtml to JavadocPackage.

Deletions:

install the Eclipse checkstyle plugin