ideas: Ctrlr Improvements - unityconstruct/CtrlrDocs GitHub Wiki

Lua Files/Methods

  • add method headers with @param and @return annotations
    • this adds intellisense hover-info to help with learning & quickly getting around
    • @param will indicate what methods want
    • @param, if typed, should at least WARN if data types matching ( haven't tested compile/runtime fully to prove this )

image

Lua Editor: Come up with best practices

Example: XStation - Seems a model of best practice, but Lua Lib not too approachable ( & likely no there was intention for it to be approachable... just functional )

  • Note: mostly note to self here
  • Think this panel was the reason I even found Ctrlr, then spazzed when I found that Ctrlr was an open source env for this type of stuff
  • After parsing several panels, seemed this creator had a solid grasp of design principles/patterns & organization.
  • Most methods were device agnostic, but vague on their purpose & have no intellisense-tastic action for understanding design/implementation.
  • uses some advance principles, such as the LCD on-the-fly graphics generation
  • Extracting methods out so I have a nice re-useable toolkit that is self-documenting and intuitive to draw from.
  • The larger the library, the more self-documenting it is & more examples available for learning
  • Lua Lib appears to live in the XML panel definition...

image

Example of Doxygen Comments

Note: Doxygen encourages these in headers vs source files image