Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.java.programmer > #39047

Re: IntStream.rangeClosed()

Show all headers | View raw

On Wed, 31 Jul 2019 07:59:52 -0400, Eric Sosman wrote:

>      I have long maintained that Javadoc is both a blessing and
> a curse: A blessing in that the programmers *almost always* write
> documentation, a curse in that the *programmers* almost always write
> documentation.
>
As somebody who started programming and system maintenance when all we 
had was source code on cards (or in a COSY library on mag tape or disk if 
you were using ICL iron) and the requirements and other documentation 
were all on flow charts (UGH), typed and/or hand-written pages in ring-
binders, the idea of Javadocs was WONDERFUL simply because it would have 
meant that the system documentation, at module level anyway) didn't get 
lost or binned. Updated? In your dreams!

Fixing bugs in assembler and COBOL programs which had minimal or no 
useful comments in them and no other accessible documentation was the 
norm: at one point I worked in a programming shop where the systems 
analysts kept no documentation - it was shredded as soon as the code 
and/or changes to it had been accepted and signed off. Smiths Industries 
of Cricklewood, London - I'm looking at you!

Ideally, in a javadocs world the class-level and method-level comments 
would be written by the members of the design team responsible for 
specifying the class structure and public method interfaces with the 
intention that these comments, together with the empty method skeletons, 
each containing only a return statement if the method returns a result 
and/or a similar skeleton if it can throw an Exception, would be clean-
compiled and run through javadocs to eliminate typos etc, before being 
passed to a programmer for completion and unit testing.

Late in the day it also occurs to me that, it shouldn't be hard to 
generate a test harness from the sort of skeletal class definition I've 
just described. I currently use such a test harness, but hand-generate 
the code that interfaces the class to be tested to the generic parts of 
the test harness, i.e. that read, parse and execute test scripts. This 
works well and is trivially easy to use for regression testing too (just 
keep known good output and compare that with output from a new run of the 
test script - if there are differences the regression test has failed.   


-- 
Martin    | martin at
Gregorie  | gregorie dot org

Back to comp.lang.java.programmer | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

Inclusive or exclusive array Cecil Westerhof <Cecil@decebal.nl> - 2019-07-30 18:24 +0200
  Re: Inclusive or exclusive array Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-07-30 12:52 -0400
    Re: Inclusive or exclusive array Cecil Westerhof <Cecil@decebal.nl> - 2019-07-30 20:41 +0200
      Re: Inclusive or exclusive array Daniele Futtorovic <da.futt.news@laposte-dot-net.invalid> - 2019-07-31 02:19 +0200
        Re: Inclusive or exclusive array Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-07-31 07:22 -0400
          Re: Inclusive or exclusive array Daniele Futtorovic <da.futt.news@laposte-dot-net.invalid> - 2019-08-01 00:44 +0200
          Re: Inclusive or exclusive array Andreas Leitgeb <avl@logic.at> - 2019-08-01 08:02 +0000
            Re: Inclusive or exclusive array Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-08-01 07:47 -0400
              Re: Inclusive or exclusive array Arne Vajhøj <arne@vajhoej.dk> - 2019-08-01 11:19 -0400
                Re: Inclusive or exclusive array Eric Douglas <e.d.programmer@gmail.com> - 2019-08-01 10:04 -0700
                Re: Inclusive or exclusive array nobody@example.org (Scott) - 2019-08-02 17:51 +0000
                Re: Inclusive or exclusive array Eric Douglas <e.d.programmer@gmail.com> - 2019-08-02 10:58 -0700
                Re: Inclusive or exclusive array nobody@example.org (Scott) - 2019-08-03 05:40 +0000
                Re: Inclusive or exclusive array Arne Vajhøj <arne@vajhoej.dk> - 2019-08-03 21:32 -0400
                Re: Inclusive or exclusive array Eric Douglas <e.d.programmer@gmail.com> - 2019-08-05 05:04 -0700
                Re: Inclusive or exclusive array Arne Vajhøj <arne@vajhoej.dk> - 2019-08-05 19:30 -0400
                Re: Inclusive or exclusive array Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-08-01 14:20 -0400
                Re: Inclusive or exclusive array Daniele Futtorovic <da.futt.news@laposte-dot-net.invalid> - 2019-08-02 01:15 +0200
                Re: Inclusive or exclusive array Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-08-02 16:17 -0400
    IntStream.rangeClosed()   (was: Re: Inclusive or exclusive array) Andreas Leitgeb <avl@logic.at> - 2019-07-31 11:33 +0000
      Re: IntStream.rangeClosed() Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-07-31 07:59 -0400
        Re: IntStream.rangeClosed() Eric Douglas <e.d.programmer@gmail.com> - 2019-07-31 05:40 -0700
          Re: IntStream.rangeClosed() Eric Sosman <esosman@comcast-dot-net.invalid> - 2019-07-31 11:02 -0400
            Re: IntStream.rangeClosed() Eric Douglas <e.d.programmer@gmail.com> - 2019-07-31 08:39 -0700
        Re: IntStream.rangeClosed() Martin Gregorie <martin@mydomain.invalid> - 2019-07-31 16:46 +0000
          Re: IntStream.rangeClosed() Eric Douglas <e.d.programmer@gmail.com> - 2019-07-31 10:16 -0700
  Re: Inclusive or exclusive array Marcel Mueller <news.5.maazl@spamgourmet.org> - 2019-07-30 23:21 +0200
  Re: Inclusive or exclusive array Arne Vajhøj <arne@vajhoej.dk> - 2019-07-30 19:43 -0400

csiph-web