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

Better and unified comment style. #37

Closed
VedVid opened this issue Nov 12, 2018 · 9 comments
Closed

Better and unified comment style. #37

VedVid opened this issue Nov 12, 2018 · 9 comments
Labels
enhancement New feature or request good first issue Good for newcomers low [priority]

Comments

@VedVid
Copy link
Owner

VedVid commented Nov 12, 2018

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:

	/*RenderWeights is created for debugging purposes;
	it clears whole map, and prints Weights of all nodes
	of graph, then waits for user input to reset;
	it's supposed to be called near the end of
	MoveTowardsPath method.*/

would become

	/* RenderWeights is created for debugging purposes  
	   It clears whole map and prints Weights of all nodes
           of graph, then waits for user input to reset.
	   It's supposed to be called near the end of 
           MoveTowardsPath method. */
@VedVid VedVid added good first issue Good for newcomers low [priority] enhancement New feature or request labels Nov 12, 2018
@VedVid
Copy link
Owner Author

VedVid commented Nov 13, 2018

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.

@VedVid
Copy link
Owner Author

VedVid commented Nov 13, 2018

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.

@VedVid
Copy link
Owner Author

VedVid commented Nov 13, 2018

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.

@VedVid
Copy link
Owner Author

VedVid commented Nov 13, 2018

Another function comments refactored by 7786f6b

@VedVid
Copy link
Owner Author

VedVid commented Dec 13, 2018

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.

@VedVid
Copy link
Owner Author

VedVid commented Jan 15, 2019

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

@VedVid
Copy link
Owner Author

VedVid commented Jan 21, 2019

missing comments in err_.go - fixed

@VedVid
Copy link
Owner Author

VedVid commented Feb 17, 2019

Current TODO:

NewTile in map.go needs better comment.

init in main.go needs better comment.

@VedVid
Copy link
Owner Author

VedVid commented Feb 26, 2022

Finished 7ca652e

@VedVid VedVid closed this as completed Feb 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers low [priority]
Projects
None yet
Development

No branches or pull requests

1 participant