From: Paul van Delst on
analyst41(a)hotmail.com wrote:
> On Feb 20, 1:42 pm, Dan Nagle <danna...(a)verizon.net> wrote:
>> Hello,
>>
>> analys...(a)hotmail.com wrote:
>>> I suppose this applies to any programming language.
>>> What does the standard say about pictures as comments ?
>>> I think it would be a great idea.
>> You may place any characters you want following a !,
>> so a url to a graphic is as ok as anything else.
>>
>> --
>> Cheers!
>>
>> Dan Nagle
>> Purple Sage Computing Solutions, Inc.
>
> Well,pushing the idea further, we should be able to put both the
> source code and text and graphic comments all together at an editable
> web page and some kind of IDE interface should be able extract only
> the source code for compilation.

I'll bite (I'm assuming you're having a slow day and need a bit of a troll fix :o)

All I can think of is the constant state of conflict the file would be in after I've
checked the code out of the repository, stripped the graphics, made textual changes, and
checked my regular old text file back in. The next graphics enabled checkin would
(presumably) replace all the cruft back in there.

I may be(coming) a bit of a curmudgeon, but what possible benefit would inline images in
source code provide? Most source code is already cluttered up with regular old ASCII.

cheers,

paulv

--
Paul van Delst Ride lots.
CIMSS @ NOAA/NCEP/EMC Eddy Merckx
From: analyst41 on
On Feb 20, 5:29 pm, Paul van Delst <Paul.vanDe...(a)noaa.gov> wrote:
> analys...(a)hotmail.com wrote:
> > On Feb 20, 1:42 pm, Dan Nagle <danna...(a)verizon.net> wrote:
> >> Hello,
>
> >> analys...(a)hotmail.com wrote:
> >>> I suppose this applies to any programming language.
> >>> What does the standard say about pictures as comments ?
> >>> I think it would be a great idea.
> >> You may place any characters you want following a !,
> >> so a url to a graphic is as ok as anything else.
>
> >> --
> >> Cheers!
>
> >> Dan Nagle
> >> Purple Sage Computing Solutions, Inc.
>
> > Well,pushing the idea further, we should be able to put both the
> > source code and text and graphic comments all together at an editable
> > web page and some kind of IDE interface should be able extract only
> > the source code for compilation.
>
> I'll bite (I'm assuming you're having a slow day and need a bit of a troll fix :o)
>
> All I can think of is the constant state of conflict the file would be in after I've
> checked the code out of the repository, stripped the graphics, made textual changes, and
> checked my regular old text file back in. The next graphics enabled checkin would
> (presumably) replace all the cruft back in there.
>
> I may be(coming) a bit of a curmudgeon, but what possible benefit would inline images in
> source code provide? Most source code is already cluttered up with regular old ASCII.
>
> cheers,
>
> paulv
>

You don't think that diagrams (I don't mean flowcharts) lined up by
the side of code-listings offer an opportunity for clear and concise
documentation ?

> --
> Paul van Delst Ride lots.
> CIMSS @ NOAA/NCEP/EMC Eddy Merckx- Hide quoted text -
>
> - Show quoted text -


From: Gary Scott on
analyst41(a)hotmail.com wrote:
> On Feb 20, 5:29 pm, Paul van Delst <Paul.vanDe...(a)noaa.gov> wrote:
>
>>analys...(a)hotmail.com wrote:
>>
>>>On Feb 20, 1:42 pm, Dan Nagle <danna...(a)verizon.net> wrote:
>>>
>>>>Hello,
>>
>>>>analys...(a)hotmail.com wrote:
>>>>
>>>>>I suppose this applies to any programming language.
>>>>>What does the standard say about pictures as comments ?
>>>>>I think it would be a great idea.
>>>>
>>>>You may place any characters you want following a !,
>>>>so a url to a graphic is as ok as anything else.
>>
>>>>--
>>>>Cheers!
>>
>>>>Dan Nagle
>>>>Purple Sage Computing Solutions, Inc.
>>
>>>Well,pushing the idea further, we should be able to put both the
>>>source code and text and graphic comments all together at an editable
>>>web page and some kind of IDE interface should be able extract only
>>>the source code for compilation.
>>
>>I'll bite (I'm assuming you're having a slow day and need a bit of a troll fix :o)
>>
>>All I can think of is the constant state of conflict the file would be in after I've
>>checked the code out of the repository, stripped the graphics, made textual changes, and
>>checked my regular old text file back in. The next graphics enabled checkin would
>>(presumably) replace all the cruft back in there.
>>
>>I may be(coming) a bit of a curmudgeon, but what possible benefit would inline images in
>>source code provide? Most source code is already cluttered up with regular old ASCII.
>>
>>cheers,
>>
>>paulv
>>
>
>
> You don't think that diagrams (I don't mean flowcharts) lined up by
> the side of code-listings offer an opportunity for clear and concise
> documentation ?

I think that's fine. If someone wanted to create a documentation and CM
system that displayed the text-based source code along side of related,
formatted, documentation that would be nice. I don't see that it needs
to be part of the source code itself.


>
>
>>--
>>Paul van Delst Ride lots.
>>CIMSS @ NOAA/NCEP/EMC Eddy Merckx- Hide quoted text -
>>
>>- Show quoted text -
>
>
>


--

Gary Scott
mailto:garylscott(a)sbcglobal dot net

Fortran Library: http://www.fortranlib.com

Support the Original G95 Project: http://www.g95.org
-OR-
Support the GNU GFortran Project: http://gcc.gnu.org/fortran/index.html

If you want to do the impossible, don't hire an expert because he knows
it can't be done.

-- Henry Ford
From: Johan on
On 20 Feb 2007 10:34:19 -0800
analyst41(a)hotmail.com wrote:

> I suppose this applies to any programming language.
>
> What does the standard say about pictures as comments ?
>
> I think it would be a great idea.
>
I use LaTeX in the comments. With a Python-script source files are
converted to .tex files and a PDF is created. \includegraphic can be
used in this case to add a graphic.


Johan
From: Brooks Moses on
Dan Nagle wrote:
> analyst41(a)hotmail.com wrote:
>> I suppose this applies to any programming language.
>>
>> What does the standard say about pictures as comments ?
>>
>> I think it would be a great idea.
>
> You may place any characters you want following a !,
> so a url to a graphic is as ok as anything else.

Indeed.

For example, you can use LaTeX markup in your comments, and then run the
source code through my "f95totex" program [1], and get pretty equations
and formatting in your comments. Or embedded pictures; LaTeX has handy
commands to do that, too.

Similarly, the standard would certainly permit a GUI program editor that
worked on something that looked like the processed output from that, so
long as the representation in the file agreed with the standard. (And
that's a pretty loose requirement, really, given that the standard only
actually has restrictions on how the file contents are interpreted -- if
your compiler ignores embedded images in files, then a file with an
embedded image is a legal Fortran program for that compiler. But it
would be nicer to embed the image as uuencoded stuff behind comments, or
put it in a separate file, so it would be a legal Fortran program on
other compilers too.)

- Brooks


[1] http://files.dpdx.net/tex/f95totex/

--
The "bmoses-nospam" address is valid; no unmunging needed.