[KIEKER-108] Decide on common coding conventions

kieker-monitoring / kieker

Kieker's main repository

Apache License 2.0

70 stars 41 forks source link

[KIEKER-108] Decide on common coding conventions #1739

Closed rju closed 5 days ago

rju commented 1 week ago

JIRA Issue: KIEKER-108 Decide on common coding conventions Original Reporter: Andre van Hoorn

So far, we have not decided on common coding conventions. This leads to problems when having auto-formatting activated with different formatting styles in IDEs like Eclipse.

We should at least add project-specific formatting style for Eclipse, as most Kieker developers use Eclipse.

Additionally, once the code adheres to committed coding conventions, we should enforce these in the build files (e.g., using a plugin like Checkstyle).

rju commented 6 days ago

author André van Hoorn -- Tue, 30 Aug 2011 14:40:47 +0200

Added to the [next meeting's agenda|meeting-20110929].

rju commented 6 days ago

author rju -- Wed, 28 Sep 2011 21:03:23 +0200

We agreed on the Eclipse Coding Conventions http://wiki.eclipse.org/Coding_Conventions which are derivate of the SUN coding conventions http://www.oracle.com/technetwork/java/codeconvtoc-136057.html.

We deviate from the ECC / SUN conventions in paragraph 4.1 as we allow 160 characters per line.

rju commented 6 days ago

author rju -- Wed, 28 Sep 2011 21:10:06 +0200

The changed profile is available in kieker/software/kieker/trunk and named kieker-eclipse-formater.xml

rju commented 6 days ago

author André van Hoorn -- Wed, 28 Sep 2011 21:18:01 +0200

Replying to [rju|comment:6]:
> The changed profile is available in kieker/software/kieker/trunk and named kieker-eclipse-formater.xml

Thanks Reiner.

Could you rename the file to eclipse-format*t*er.xml?
How can the formatting rules be activated? Can we enforce them automatically?

rju commented 6 days ago

author Jan Waller -- Tue, 4 Oct 2011 17:37:10 +0200

Why 200 Chars?

Renamed file and added also 200 chars for comments