Front page | perl.perl6.internals |
Postings from February 2001
On Tuesday 20 February 2001 10:49, David Mitchell wrote: > Regarding comments in code: > 2. Is this the time and place to discuss it? Certainly before we actually begin coding.... > > 3. Should the result of the discusssion be a PDD? Yes. > > 5. Do *all* these comments need to be extractable, or only ones related > to published APIs etc? All extractable comments need to be extractable, which doesn't make sense, I know. There are two, maybe three different kinds of comments - metadata type comments (like which API is belongs to, versioning, authorship, etc), explanatory ( /* one little, two little, three little endians */ ), and completely unnecessary ( /* Twas brillig... */ and most prologues ) The first, certainly, whether we plan to extract them now or not. The second, of course not, they are meaningless without the code. They're often meaningless *with* the code. The third, maybe, if only for trivialness. :-) > > 6. Can we leave the details of pod/apidoc/rfc281 until 1..5 have been > agreed? Good idea. Define the why, the what, and then the how. -- Bryan C. Warnock bwarnock@capita.comThread Previous | Thread Next