Well, since this is about comments and code, let’s look at some actual code. Compare this typical code: float a, b, c; a=9.81; b=5; c= .5*a*(b^2); To this self-documenting code, which shows what is being done: const float gravitationalForce = 9.81; float timeInSeconds = 5; float displacement = (1 / 2) * gravitationalForce * (timeInSeconds … Read more
So why is API documentation written in such a way as to confuse perennial newbs / hackers / DIYers like myself? It’s really not meant to be written that way. I’ll agree there seems to be no ease of use across API documentations. However, there is a lot of cross over from older man style … Read more
So why is API documentation written in such a way as to confuse perennial newbs / hackers / DIYers like myself? It’s really not meant to be written that way. I’ll agree there seems to be no ease of use across API documentations. However, there is a lot of cross over from older man style … Read more