Docstrings considered too complicated

[D'Arcy J.M. Cain]

On 27 Feb 2010 00:02:40 GMT
Steven D'Aprano <steve at REMOVE-THIS-cybersource.com.au> wrote:
> On Fri, 26 Feb 2010 09:09:36 -0600, Tim Daneliuk wrote:
> > mov  AX,BX               ; Move the contents of BX into AX
> 
> That's a *good* comment, because without it most English-speaking people 
> would assume you were moving the contents of AX into BX.

But it isn't English, it's assembler.   If someone doesn't know that
assembler they have no business trying to work in it.

A good comment would be "move number of sheep into accumulator" or
something equally as descriptive.  A person who knows the assembler
knows that the BX register will be copied (not "moved" btw) into the AX
register.  What they want from the comment is some idea why.

Yes, understanding assembler is hard.  You aren't going to learn it
from the comments.

-- 
D'Arcy J.M. Cain <darcy at druid.net>         |  Democracy is three wolves
http://www.druid.net/darcy/                |  and a sheep voting on
+1 416 425 1212     (DoD#0082)    (eNTP)   |  what's for dinner.