Revisions to Implementing N-ary trees in C

deleted 158 characters in body

Source Link

edited Jan 6, 2018 at 1:42

Jamal

35.2k
13
134
238

Looking at my code, I feel like it is not instantly clear for someone whowho did not write it. II feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. DoDo you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C code) at commenter's suggestion.}

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C code) at commenter's suggestion.}

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

replaced http://stackoverflow.com/ with https://stackoverflow.com/

Source Link

edited May 23, 2017 at 12:40

Community Bot

1

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C codeImproving the legibility of my C code) at commenter's suggestion.}

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C code) at commenter's suggestion.}

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C code) at commenter's suggestion.}

Post Merged (destination) from codereview.stackexchange.com/questions/109261/…

occurred Oct 30, 2015 at 19:00

copy-edited, corrected link

Source Link

edit approved Oct 16, 2015 at 9:29

Deduplicator

19.9k
1
32
65

Crossposted from stack overflow at commenter suggestion

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C code) at commenter's suggestion.}

Crossposted from stack overflow at commenter suggestion

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

Looking at my code, I feel like it is not instantly clear for someone who did not write it. I feel like readability will be important for me in the future, if I'm ever to write code on an enterprise, or open source project. Do you have any advice as to how I can make this and future C more readable?

#include "datatypes.h"
#include <stddef.h>

//Changes the node's child (if it doesn't exist) to newChild
//or appends newChild to the end of the node's child's sibling list
void addChild ( treeNode *root, treeNode *newChild ) {
  treeNode *temp;
  if ( root->child == NULL ) {
    root->child = newChild;
  } else {
    temp = root->child;
    while ( temp->sibling != NULL ) {
      temp = temp->sibling;
    }
    temp->sibling = newChild;
  }
}

//Returns a new treeNode with default data values or {0,NULL,NULL}
treeNode newNode () {
  treeNode node = {0, NULL, NULL};
  return node;
}

datatypes.h

typedef struct treeNode {
  int n;
  struct treeNode *child;
  struct treeNode *sibling;
} treeNode;

treeNode newNode (); //Returns a treenode with default {0,NULL,NULL}
void addChild ( treeNode *t, treeNode *c ); //Adds child to the given  treeNode

_{Crossposted from Stack Overflow (Improving the legibility of my C code) at commenter's suggestion.}

Post Unlocked by 200_success

occurred Oct 15, 2015 at 19:58

Notice removed Content dispute by 200_success

occurred Oct 15, 2015 at 19:58

Post Locked by 200_success

occurred Oct 15, 2015 at 19:57

Notice added Content dispute by 200_success

occurred Oct 15, 2015 at 19:57

Rollback to Revision 7

Source Link

edited Oct 15, 2015 at 19:57

200_success

145.7k
22
191
481

Loading

Rollback to Revision 5

Source Link

edited Oct 15, 2015 at 19:57

Jeffrey Brown

155
1
9

Loading

edited tags; edited title

Link

edited Oct 15, 2015 at 19:56

200_success

145.7k
22
191
481

Loading

Rollback to Revision 2

Source Link

edited Oct 15, 2015 at 19:55

200_success

145.7k
22
191
481

Loading

added 29 characters in body

Source Link

edited Oct 15, 2015 at 19:55

Jeffrey Brown

155
1
9

Loading

edited tags

Link

edited Oct 15, 2015 at 19:47

200_success

145.7k
22
191
481

Loading

deleted 48 characters in body

Source Link

edited Oct 15, 2015 at 19:46

Jeffrey Brown

155
1
9

Loading

deleted 762 characters in body

Source Link

edited Oct 15, 2015 at 19:30

Jeffrey Brown

155
1
9

Loading

Source Link

asked Oct 15, 2015 at 19:16

Jeffrey Brown

155
1
9

Loading

Stack Exchange Network

Return to Question