Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADD MORE EXPLANATORY COMMENTS #8

Open
svhawkins opened this issue Sep 2, 2023 · 0 comments
Open

ADD MORE EXPLANATORY COMMENTS #8

svhawkins opened this issue Sep 2, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@svhawkins
Copy link
Owner

svhawkins commented Sep 2, 2023

Add more structured comments, especially for functions and structs

  • add commments in the main programs
  • add comments describing tests and what they are testing more in detail (ie write out the 'code snippet' version of the ASTs)
  • add comments for enumerations

for functions and/or member functions:

/**
*@name
*@brief  <brief description of function>
*@param <parameter name> <description, include type>
*@param <parameter name> <description, include type>
*...
*@return <descritption, include type>
*
* <optional> detailed description
* - highlight failure cases
* - highlight special cases
* - highlight behavior/state changes
*/

for structures/classes:

/*
* structure name
* @brief <description>
* @member <type : member variable name> <description>
*/
@svhawkins svhawkins self-assigned this Sep 2, 2023
@svhawkins svhawkins added the documentation Improvements or additions to documentation label Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant