Ich halte es durchaus für sinnvoll. Erst muss in den Kopf rein, das man Dokumentation schreiben muss und eventuell entwickelt der Student irgendwann ein Verständnis dafür, wann Dokumentation nötig ist.
Den Namen der Variable noch mal in aufgeblähter Form hinzuschreiben erfüllt aber für mich gar nicht erst die Kriterien einer „Dokumentation“, da man hierdurch keine Information gewinnt. Hier mal ein Auszug aus der Musterlösung einer Übungsaufgabe:
Code:
/**
* A bike model in Java
*
* @author [anonymisiert]
* @version 1.2
*/
class Bike {
/**
* The gears of the bike
*/
Gears gears;
/**
* The wheels of the bike
*/
Wheels wheels;
/**
* Indicates the price of the Bike
*/
int price;
Huii, wer hätte es gedacht...