The difficult part in my experience is describing the structure and contents of my inputs and outputs.
Usually, I provide sample datasets, and show what verbs to run on them. But I don't have too many readers of my code so I am not sure how practical that really is. I was wondering whether naming the main data structures encountered would be useful? Philip Le 14.01.2014 16:01, Raul Miller a écrit : > I have also struggled with documentation, and not only in the context > of apl and/or j. > > I sometimes wonder, though, how important it really is. So much of the > skill of computer programming comes through seeing the code through > experimentation and seeing both the code and its variants in action. > > Quite often, I find that the code makes a lot more sense when I see > what it is doing. (And, all too often, that winds up being "nothing > useful" so then I wonder if there are other cases where it would be > useful.) > > Anyways, writing documentation is a mentally and socially intensive > task, and I have the utmost respect for people that can do it well. > And good documentation gives valuable perspectives and insight into > the underlying code. But... it's a struggle for me. > > Thanks, > > -- > Raul ---------------------------------------------------------------------- For information about J forums see http://www.jsoftware.com/forums.htm
