Commenting step 1

[jforchheimer25]

Pull Request for Commenting Branch

[dlezcan1]

@jforchheimer25 Thread here: I believe the structure of an abstract static class is more confusing than just using standard comment blocks for all functions and classes

[dlezcan1]

When people want explanation for things I would like for everything to be in the same place

@jforchheimer25 Then you can do that 1 of two ways. 1: A separate .java file with comment block descriptions, or a README.md file which connects all of these together. A class with arbitrary functions which return arbitrary integers is confusing and clunky. It's sleeker to stick to comment blocking

[dlezcan1]

What about command Scheduler etc. I want to make it so that each student who wants to code after me knows exactly where to look for stuff. I cant java doc the init sendable stuff really and command scheduler stuff

This can be commented where it is implemented. We could have a separate function on each and link them to the web pages with our simpler explanation

[jforchheimer25]

This can be commented where it is implemented. We could have a separate function on each and link them to the web pages with our simpler explanation

could you show an example?

[dlezcan1]

Here is an example for Python of good structured commenting:

https://github.com/PhotonVision/photonvision/blob/master/photon-lib/py/photonlibpy/photonPoseEstimator.py

[jforchheimer25]

Here is an example for Python of good structured commenting:

https://github.com/PhotonVision/photonvision/blob/master/photon-lib/py/photonlibpy/photonPoseEstimator.py

Ill Remove the class later then. Im more focused on getting the explanations in first.

[dlezcan1]

Sure, but keep new additions to be class-based and function-based. No need for the Explanation functions.