ohloh: rpg-1d6 ist sehr gut kommentiert!

Ich habe gerade in unsere Statistiken bei ohloh geschaut:

http://www.ohloh.net/projects/7065/factoids

------
Factoid: "Extremely well-commented source code"
rpg-1d6 is written mostly in Python.
Across all Python projects on Ohloh, 11% of all source code lines are comments. For rpg-1d6, this figure is 23%.
This very impressive number of comments puts rpg-1d6 among the best 10% of all Python projects on Ohloh.
A high number of comments might indicate that the code is well-documented and organized, and could be a sign of a helpful and disciplined development team.
------

Wobei ich denke, dass wir das trotzdem noch erhöhen sollten, am besten soweit, dass auch nicht-Programmierer alleine mit den Kommentaren verstehen können, was wo (teilweise auch wie) gemacht wird.

Ich habe dafür schonmal ein paar zusätzliche Kommentare eingefügt, v.a. aber erstmal für epydoc (als erste nicht auskommentierte Codezeile).

Beispiel:

------
#!/bin/env python
# encoding: utf-8

# lizenz
# lizenz
# lizenz

"""Das ist die Kurzbeschreibung. Eine Zeile, die in Auflistungen gezeigt wird. 

Hier kommt nun die Langform. Sie kann beliebig formatiert werden 
und beliebig viele Zeilen überspannen.

Beispielsweise können wir hier schreiben, wie die Module genutzt werden können, 
und wir können Beispiele geben. """

def class Kommentarbeispiel: 
	"""Ab hier kommt dann der Code. 

Soweit ich weiß, können auch Klassen mit komplexen Kommentaren versehen werden."""
	# Ein Kommentar mit Doppelpunkt dahinter sollte eigentlich die Variable beschreiben. 
        # Geht aber wohl erst mit der nächsten Version von epydoc, 
        # und die will gerade nicht kompilieren. 
        
	#: Yay! Code! 
	code = "was sinnvolles machen"

------

Lieben Gruß,
Arne