Opened 3 years ago

Last modified 2 years ago

#220 assigned defect

Java code review: Code documentation (de: Quellcode-Durchsicht: Dokumentierung)

Reported by: vasco.kolmorgen Owned by: birgit.jaekel
Priority: minor Component: General and Main Views
Version: 1.3 Keywords: code review documentation
Cc: birgit.jaekel, torben.brand, thomas.nygreen

Description

Feedback from Jernbaneverket (20.05.2016 (09:10:33 CEST)):

There are a lot of (public) classes in railVIVID with no documentation of the purpose of the class. Most public methods have no meaningful documentation at all. So a developer will have to rely on class and method names always being self-explanatory and unambiguous, which they currently not always are. The railVIVID code is riddled with

// TODO: Auto-generated Javadoc

which should either be replaced by proper documentation or simply removed if the documentation already is sufficient. The code itself is hardly documented at all.

Change History (4)

comment:1 Changed 3 years ago by vasco.kolmorgen

  • Owner set to birgit.jaekel
  • Status changed from new to assigned

comment:2 Changed 3 years ago by vasco.kolmorgen

  • Version changed from 1.0.6 to 1.1.x

comment:3 Changed 3 years ago by vasco.kolmorgen

ongoing task

comment:4 Changed 2 years ago by vasco.kolmorgen

  • Priority changed from major to minor
  • Version changed from 1.1.x to 1.3
Note: See TracTickets for help on using tickets.