When a particular portion of code is complex or difficult enough to understand, I find it advisable to go overboard on commentary and explanation. By swamping one or two lines of functionality with twenty lines of explanation, we visually convey to the reader that “we know this is complex, and we’re going to do our damnedest to help you understand it.” Before they even begin to read the commentary or associated code, we can ease their mind by dispersing the smallest amount of code possible amongst the largest amount of explanation we can write.
(P.S. I know Dribbble isn’t Forrst. I’m not posting my code as code, I’m posting it as visual art. I consider source code a medium for artistic expression, hence why I’m posting my work here in this way. I’ll be trying to post shots from various languages / markups, in various styles; anything I consider to be visually interesting. I also may be adjusting the hilighting and typography to make the shots more visually appealing.)
2 Responses
(it: EnvironmentedProc.rb @ b524418, lines 78 ‒ 97)
When a particular portion of code is complex or difficult enough to understand, I find it advisable to go overboard on commentary and explanation. By swamping one or two lines of functionality with twenty lines of explanation, we visually convey to the reader that “we know this is complex, and we’re going to do our damnedest to help you understand it.” Before they even begin to read the commentary or associated code, we can ease their mind by dispersing the smallest amount of code possible amongst the largest amount of explanation we can write.
about 1 year ago
(P.S. I know Dribbble isn’t Forrst. I’m not posting my code as code, I’m posting it as visual art. I consider source code a medium for artistic expression, hence why I’m posting my work here in this way. I’ll be trying to post shots from various languages / markups, in various styles; anything I consider to be visually interesting. I also may be adjusting the hilighting and typography to make the shots more visually appealing.)
about 1 year ago