Code Style: Magic Numbers and Strings - Githubissues

tthuem / VariantSync

Automating the synchronization of software variants

GNU Lesser General Public License v3.0

6 stars 2 forks source link

Code Style: Magic Numbers and Strings #56

Open wurstbroteater opened 3 years ago

wurstbroteater commented 3 years ago

In the project, there are several occurences of so called magic numbers like here: https://github.com/tthuem/VariantSync/pull/53#discussion_r565606093

Also there are occurences of unclear REGEX usages like here: https://github.com/tthuem/VariantSync/pull/53#discussion_r565588397 and https://github.com/tthuem/VariantSync/pull/53#discussion_r565588551

It is not OS save to use \n, so we have to change it to String.format("%n") and StringBuilder should be used in general

This issue is considered as done if:

All unclear magic numbers are identified and documented (optional: in wiki)
The purpose or usage of the magic number has been documented (optional : in wiki)
The purpose or usage of the REGEX Strings has been documented (optional : in wiki)
All occurences of \n have been changed to String.format("%n")
Every usage of String is be replaced with StringBuilder ( this also includes String concatenation with +)