-
Notifications
You must be signed in to change notification settings - Fork 2
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
Better and unified comment style. #37
Comments
Some work was already done in 6b0c8b5 But as a non-native speaker I can't be sure if my wording is understandable for other users. |
TODO: sinBase and cosBase in fov.go are not commented. InitializeFOVTables in fov.go is not commented. NewTile in map.go needs better comment. NewCreature in monsters.go needs better comment. NewObject in objects.go needs better comment. NewPlayer in player.go needs better comment. |
sinBase, cosBase, InitializeFOVTables done by 8d377d7 TODO: NewTile in map.go needs better comment. NewCreature in monsters.go needs better comment. NewObject in objects.go needs better comment. NewPlayer in player.go needs better comment. |
Another function comments refactored by 7786f6b |
Current TODO: NewTile in map.go needs better comment. NewCreature in monsters.go needs better comment. NewObject in objects.go needs better comment. NewPlayer in player.go needs better comment. init in main.go needs better comment. |
Current TODO: NewTile in map.go needs better comment. NewCreature in monsters.go needs better comment. NewObject in objects.go needs better comment. NewPlayer in player.go needs better comment. init in main.go needs better comment. missing comments in err_.go |
missing comments in err_.go - fixed |
Current TODO: NewTile in map.go needs better comment. init in main.go needs better comment. |
Finished 7ca652e |
For now, comments are kinda mess. Sometimes they uses multiple sentences, sometimes it's only one, long sentence with lots of ";". It would be more readable if space would be inserted between /* and first word.
Example:
would become
The text was updated successfully, but these errors were encountered: