-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
standardize comments #234
Comments
`<?php This is also a single-line comment/* // You can also use comments to leave out parts of a code line |
@InsiteFX I have no idea what you're trying to say here.... @juanlopezdev I agree to some extent that we probably need to clean things up a little bit, but don't necessarily agree with all of your examples. Will leave this one open for now as a reminder to go back and clean up a bit. |
I was just showing how php.net says the standard comments should be like. |
What is IQ? |
Hello,
I really like IQ , but I have a problem with PHP comments , personally I think it is not standardized. They have a style guide for CI http://www.codeigniter.com/user_guide/general/styleguide.html#commenting and it would be advisable also to apply in developing CI4.
In my personal opinion I think that the comments of this type would have to be reserved for variables , classes, methods or functions.
And this, for any block you want to comment
// I'm a PHP comment
I also believe that you should avoid these types of comments :
// ---------------------------------------------
Currently I see this file a bit messy in a review for example.
https://github.com/bcit-ci/CodeIgniter4/blob/develop/application/Config/Routes.php
Greetings, thank you very much for giving a new version CI4
The text was updated successfully, but these errors were encountered: