search

VedVid / RAWIG

RAWIG (Roguelike Architecture, Written In Go) is ready to modify and expand roguelike architecture.
BSD 2-Clause "Simplified" License
16 stars 3 forks source link

Better and unified comment style. #37

Closed VedVid closed 2 years ago

VedVid commented 5 years ago

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 commented 5 years ago

Some work was already done in 6b0c8b5914bfc49d6935444403fd2522d029ae1f

But as a non-native speaker I can't be sure if my wording is understandable for other users.

VedVid commented 5 years ago

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 commented 5 years ago

sinBase, cosBase, InitializeFOVTables done by 8d377d7c4c76431993623000e18a6dfa66653cc9

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 commented 5 years ago

Another function comments refactored by 7786f6b1172a105c7d379aa86c3ad32a8a774572

VedVid commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

missing comments in err_.go - fixed

VedVid commented 5 years ago

Current TODO:

NewTile in map.go needs better comment.

init in main.go needs better comment.

VedVid commented 2 years ago

Finished 7ca652e66736caa110e6cf9e4c70455b45d76d1d