[Asterisk-Dev] Need help to get into the code

[Michael Giagnocavo]

Comments are part of the source. By filtering them, even after you are "done
learning", would not be a good idea. While some of the comments might be a
bit unhelpful or out of sync, you will notice at some tricky parts, there
will be comments. They are there for a reason. Filtering them out is just
going to ensure that when you get to a part that's not obvious from the
code, and where someone DID note why, you won't benefit.

At any rate, try Visual Studio 2005. For learning a codebase, I've found it
quite helpful (esp. the code definition window). I believe there is an
Express (currently free) version for C++ that will work fine for you.

-Michael

-----Original Message-----
From: asterisk-dev-bounces at lists.digium.com
[mailto:asterisk-dev-bounces at lists.digium.com] On Behalf Of Jean-Hugues
ROBERT
Sent: Tuesday, May 17, 2005 2:47 AM
To: Asterisk Developers Mailing List
Subject: Re: [Asterisk-Dev] Need help to get into the code

At 09:34 16/05/2005 -0700, you wrote:
>The thing is, the code is written _by_ developers, _for_ developers. It's 
>not written in a way that a casual reader will be able to just drop into 
>any given source file and be able to know everything that is happening 
>there. There will always be a base of knowledge required about the context 
>of any given function to be able to understand it.

I wish there would be a filter in my editor to control what level of comment
I want to see while editing the code. Something as simple as replacing the
comments by some blanks would help improve the noise/signal ratio sometimes.

Yet, when I am in "learning mode", comments help.

Regarding Open Source code, I feel like comments can have an additional
value.
I mean an Educational value, where comments help future developers, not just
about the micro-change introduced in a file, but also about the whole
picture.

This would be about sharing knowledge, in addition to sharing code.

It does not bother me if these educational comments are somehow out of sync
or
sometimes misleading, as long as, overall, they help me understand the code
faster. However, once I understand, I would like them to kind of disappear.

Any hints about an Editor with "comments filtering" capabilities ?

Yours,

   JeanHuguesRobert

-------------------------------------------------------------------------
Web:  http://hdl.handle.net/1030.37/1.1
Phone: +33 (0) 4 92 27 74 17

_______________________________________________
Asterisk-Dev mailing list
Asterisk-Dev at lists.digium.com
http://lists.digium.com/mailman/listinfo/asterisk-dev
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev