[ZBXNEXT-4749] Please add more comments to source code Created: 2018 Sep 21  Updated: 2018 Oct 10  Resolved: 2018 Oct 10

Status: Closed
Project: ZABBIX FEATURE REQUESTS
Component/s: Agent (G), Frontend (F), Java gateway (J), Proxy (P), Server (S)
Affects Version/s: None
Fix Version/s: None

Type: Change Request Priority: Major
Reporter: Marc Assignee: Unassigned
Resolution: Change request declined Votes: 1
Labels: documentation, sourcecode
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

I remember how many nights I spend to investigate the source code of Zabbix. These were the times where I learned most about Zabbix. This was real fun but consumed a significant portion of my time.

Completing the description of major functions as well as adding some more comments to certain function calls resp. key areas in a function could ease a lot to get into it and to finally understand.

Possibly it might be even worth of thinking a Docs as Code approach.
Some examples for prominent generators can for instance be found here: https://docs.opencv.org/

PS: My personal preference would be Sphinx resp. use of reStructuredText



 Comments   
Comment by dimir [ 2018 Sep 21 ]

We can't add more comments as this is against the internal rules of coding. The rules say we should write code in a way that it would speak for itself. Except for some corner cases where some complex logic must be explained. So, the lack of comments is by design.

Comment by Marc [ 2018 Sep 22 ]

That's really a pity!

Generated at Fri Apr 26 17:43:21 EEST 2024 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.