Refactor: add a detailed comments structure to config.conf file#6612
Refactor: add a detailed comments structure to config.conf file#6612FrancescoDiMuro wants to merge 30 commits intotronprotocol:developfrom
Conversation
…astForward and seed nodes
|
Recommendation: This PR should be split into two separate PRs
|
Thank you for the feedback. To avoid creating a new PR, what do you think if I just restore the original config.conf's original values? Thank you again. |
|
I strongly support this PR, having such detailed documentation directly in the config file will significantly improve developer experience while deploying a TRON node (we have received several inquiries around the config file in the past from dev community in telegram). I would recommend to eventually create a similar PR in the Nile testnet repo as well. Thanks for your support on drafting this PR @FrancescoDiMuro ! |
…FrancescoDiMuro/java-tron into feature/config-file-refactoring
Contributors using vim, emacs, IntelliJ, Sublime, and other editors, where those prefixes render as meaningless noise. Yes, the original values in the configuration file should not be changed in this pull request; if changes are required, please submit a separate pull request. |
What does this PR do?
This PR introduces a detailed and standardized commenting convention for the
config.conffile.It uses Visual Studio Code’s Better Comments extension to visually distinguish between different types of comments, improving readability and maintainability.
Why are these changes required?
The configuration file previously lacked explanations and a consistent structure for comments, making it harder to quickly identify critical notes versus general documentation.
By introducing categorized comment prefixes (
!,*,?), developers can more efficiently scan the file, understand the purpose of each section, and identify important warnings or references at a glance.This PR has been tested by: myself
Follow up
Extra details
!→ Important comments (warnings / required attention, always followed by “Please note”)*→ Informational comments (context, no action required)?→ Reference comments (links, documentation, additional resources)