search

Together-Java / TJ-Bot

TJ-Bot is a Discord Bot used on the Together Java server. It is maintained by the community, anyone can contribute.
https://togetherjava.org
GNU General Public License v3.0
97 stars 83 forks source link

String resources #1073

Open Taz03 opened 3 months ago

Taz03 commented 3 months ago

Issue

We have a lot of strings embedded into the code which is hard to manage. And it will only get worse with time.

To update a string we have to know which class to look into and find the exact line the string is created in. This is a hard task, especially for a non-programmer person.

Solution

Make an android-like R.java class that will read the strings/string templates from the XML resource file and use it in the code. Also, add a guide on how to find and update text in the wiki.

christolis commented 3 months ago

Do we really need this though? It will definitely help non-programmers with changing string values across the code without delving into it but I don't know if it's going to be a good investment. I thought that usually mostly people do this for i18n purposes but I'd love to hear other's opinions about this as well. :)

SimonVerhoeven commented 2 months ago

I think there's something to be said for both sides. A lot of inline text can be more challenging to support, on the other hand the filename does also serve as a certain reassurance that they're in the right spot.

Out of curiousity, why an XML file, and not just https://docs.oracle.com/en%2Fjava%2Fjavase%2F22%2Fdocs%2Fapi%2F%2F/java.base/java/util/ResourceBundle.html + a properties file?