Skip to content

Instantly share code, notes, and snippets.

@ik5

ik5/documented_code.c

Last active March 14, 2018 08:38
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ik5/f0e7178a558885d938978171b623fbda to your computer and use it in GitHub Desktop.
Save ik5/f0e7178a558885d938978171b623fbda to your computer and use it in GitHub Desktop.
Download ZIP
example of self documenting code
Raw
documented_code.c
/* ... */
const char * get_message(void * payload) {
payload_t *data = payload;
if (!data->len > MIN_PAYLOAD_LEN) {
return null;
}
return sprintf("%s%s", data->name, data->content);
}
/* ..*/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment