Skip to content
This repository was archived by the owner on Oct 12, 2018. It is now read-only.
This repository was archived by the owner on Oct 12, 2018. It is now read-only.

Standardize comments and optimizations across all examples #5

@gamedevsam

Description

@gamedevsam

Each example should be as complete and straight forward as possible (including ample use of comments). Also, we should strive to use the best coding practices we can think of, considering users are likely to use this code as the framework for their own projects.

Watch this video, and this video, to learn more about the concept of "clean code", to learn some good coding practices.

In general:

  • Keep comment capitalization consistent.
  • Comment everything.
  • Avoid branches that just return if the condition is false at the top of a function, move that check upwards, and branch before calling the function (see example here).

We should keep this list updated, and turn it into a contributing guide, for those interested in adding their own examples.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions