I finally decided that I had added all that I should to the project, and submitted it on Friday.
I think the only thing the evaluators may not like is the commenting. I had gone back and forth on the comments, trying to keep them consistent without overdoing it. I think I ended up overdoing it anyway.
I had asked in Piazza about the necessity of JSDoc, and was told it should not affect the project evaluation. It seemed like JSDoc might be overkill for this size project, but I can see where it could be helpful to someone coming along and wanting auto-documentation. I think what I did put in as comments would be enough for someone trying to follow behind me.
In reading up on self-documenting code (search Stack Overflow for several posts about it), it seems that the general consensus is that although code can give you a lot of information about what is is doing, it cannot give you the WHY something was coded a specific way. I tried to leave my comments as "why" explanations, expecting the rest would explain itself. Once I get the review, I'll know whether that was enough.
Final submission link: here
I think the only thing the evaluators may not like is the commenting. I had gone back and forth on the comments, trying to keep them consistent without overdoing it. I think I ended up overdoing it anyway.
I had asked in Piazza about the necessity of JSDoc, and was told it should not affect the project evaluation. It seemed like JSDoc might be overkill for this size project, but I can see where it could be helpful to someone coming along and wanting auto-documentation. I think what I did put in as comments would be enough for someone trying to follow behind me.
In reading up on self-documenting code (search Stack Overflow for several posts about it), it seems that the general consensus is that although code can give you a lot of information about what is is doing, it cannot give you the WHY something was coded a specific way. I tried to leave my comments as "why" explanations, expecting the rest would explain itself. Once I get the review, I'll know whether that was enough.
Final submission link: here
No comments:
Post a Comment