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.

Sign up for GitHub

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

Jump to bottom

Uniformalize function argument names. Remove i and o prefix from argument names #39

Closed
end2endzone opened this issue Apr 25, 2021 · 0 comments
Closed

Uniformalize function argument names. Remove i and o prefix from argument names #39

end2endzone opened this issue Apr 25, 2021 · 0 comments
Labels
code cleanup The code needs optimization Documentation

Comments

@end2endzone
Copy link
Owner

Function arguments have multiple coding standard. One of them is prefixing all function arguments with i or o. This is a naming convention I learned at work and I do not think it is largely used in the outside world. The goal is to prefix variables with an i when the variable is an input and an o when the variable is an output (like Parse() functions defined in RapidAssist).

I consider removing the i and the o prefixes as I don't think it is intuitive enough for people outside of my work environment. I am also not always consistent across all files.

We might also adopt function arguments naming convention defined in Google's C++ Style Guide.
@end2endzone end2endzone added Documentation code cleanup The code needs optimization labels Apr 25, 2021
@end2endzone end2endzone changed the title Uniformalize function argument names. Remove i and o from argument names Uniformalize function argument names. Remove i and o prefix from argument names Apr 26, 2021
end2endzone added a commit that referenced this issue Apr 26, 2021
@end2endzone
* Fixed issue #39: Uniformalize function argument names. Remove i and…
b304b5e 
… o prefix from argument names.
end2endzone added a commit that referenced this issue Apr 27, 2021
@end2endzone
Merge branch 'feature-issue39' #39
31bf9d4 
* feature-issue39:
  * Fixed issue #39: Uniformalize function argument names. Remove i and o prefix from argument names.
end2endzone added a commit that referenced this issue Jun 10, 2021
@end2endzone
Additional changes for issue #39: Uniformalize function argument name…
531643e 
…s. Remove i and o prefix from argument names.
end2endzone added a commit that referenced this issue Jun 12, 2021
@end2endzone
Merge branch 'feature-issue47' #47 #50
ec2383c 
* feature-issue47:
  * Fixed issue #47: Allow generating into subfolder. * Fixed issue #50: Change File and FileManager macro guards prefix according to specified namespace.
  Moved code related to directory parsing to a dedicated function `processInputDirectory()` to match `processInputFile()` function behavior.
  Additional changes for issue #39: Uniformalize function argument names. Remove i and o prefix from argument names.
  Small code simplifications for clarity.
  Renamed some function arguments. Implemented IGenerator::setHeaderFilename() and IGenerator::getHeaderFilename()
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code cleanup The code needs optimization Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@end2endzone