From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=ham autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: 103376,e61c8636ef35379d X-Google-Attributes: gid103376,public X-Google-ArrivalTime: 2001-01-20 06:36:42 PST Path: supernews.google.com!sn-xit-02!supernews.com!nntp-relay.ihug.net!ihug.co.nz!news-spur1.maxwell.syr.edu!news.maxwell.syr.edu!news.algonet.se!algonet!uninett.no!ntnu.no!randhol+abuse From: randhol+abuse@pvv.org (Preben Randhol) Newsgroups: comp.lang.ada Subject: Re: Examples in Docs, was Re: Escape Sequences in Strings Date: 20 Jan 2001 14:36:40 GMT Organization: Norwegian university of science and technology Message-ID: References: <93objj$guk$1@nnrp1.deja.com> <93q77h$rr6$1@nnrp1.deja.com> <940f9j$nj2$1@nnrp1.deja.com> <94299p$8dd$1@nnrp1.deja.com> <94a2jj$tc2$1@nnrp1.deja.com> <94c73f$hs9$1@nnrp1.deja.com> NNTP-Posting-Host: kiuk0156.chembio.ntnu.no X-Trace: kopp.stud.ntnu.no 980001400 17809 129.241.83.82 (20 Jan 2001 14:36:40 GMT) X-Complaints-To: usenet@itea.ntnu.no NNTP-Posting-Date: 20 Jan 2001 14:36:40 GMT User-Agent: slrn/0.9.6.3 (Linux) Xref: supernews.google.com comp.lang.ada:4233 Date: 2001-01-20T14:36:40+00:00 List-Id: On Sat, 20 Jan 2001 14:24:50 GMT, Robert Dewar wrote: > >Generally I much prefer ALL technical documentation (as opposed >to user documentation) of the code to be in the code. Why? >Simple, in my experience VERY few programmers have the >discipline to maintain external documents, so they quickly get >out of sync and become completely useless. I agree. If one wanted an external documentation, one can run a script/program which extracts the documentation from the sourcefiles and assemble it as one likes. Then it would be easier to maintain an external document as well if that was desired. -- Preben Randhol ---------------- http://www.pvv.org/~randhol/ -- iMy favorite editor is Emacs!bcwVim -- vim best-editor.txt