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

Enhance code comments #191

Open
atsju opened this issue Apr 18, 2021 · 1 comment
Open

Enhance code comments #191

atsju opened this issue Apr 18, 2021 · 1 comment

Comments

@atsju
Copy link
Collaborator

atsju commented Apr 18, 2021

Who has never read his own code and didn't understand it a year after ?

This repo becomes bigger, greater and more used every day and even if I'm able to write some cmake code I do not consider myself as expert. It is often quite difficult for me to understand exactly what the code does.

I think a minimum of comment should be added and every new PR should have (in an ideal world) :

  • comments for the added code
  • documentation update if behavior changes

Also the original code should be commented in the futur.

Comment shall not explain what set does on every line but regex, general flow and "advanced" cmake features (I know this means nothing depending on people) could definitely be.

(#190 mentions this problem).

image

@gudnimg
Copy link
Contributor

gudnimg commented Jun 22, 2021

I agree. Its hard to see what the code is doing sometimes 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants