You are viewing a plain text version of this content. The canonical link for it is here.
Posted to c-dev@axis.apache.org by Susantha Kumara <su...@opensource.lk> on 2004/06/17 09:06:20 UTC
Adding modification comments to source files
Hi all,
I have seen that we have recently started adding comments to source
files like
/*
* Revision 1.3 2004/05/xx <developer name>
* Some description about the modification done
*/
I also see that the Revision mentioned in many of these comments is not
the revision to which that changes were made. See
cvs log Call.h
I suggest that we should not add such comments to source files because
they grows the size of the . But any comments that should go to doxygen
docs are ok.
What do you think about this.
you can always see the cvs logs using
cvs log <file>
Thanks,
Susantha
---
Re: Adding modification comments to source files
Posted by Aleksander Slominski <as...@cs.indiana.edu>.
Samisa Abeysinghe wrote:
>I did this because Xerces has it and because it makes easy to see what changes made.
>
>
>
Samisa,
i think what you may want to do is ti add /* $Log: $ */ at bototm of the
source file and CVS will automatically expand $Log: $ into what yo
uwould get from cvs log - for details see:
http://cvsbook.red-bean.com/cvsbook.html#Using%20Keyword%20Expansion
alek
>--- Susantha Kumara <su...@opensource.lk> wrote:
>
>
>>Hi all,
>>
>>I have seen that we have recently started adding comments to source
>>files like
>>
>>/*
>> * Revision 1.3 2004/05/xx <developer name>
>> * Some description about the modification done
>> */
>>
>>I also see that the Revision mentioned in many of these comments is not
>>the revision to which that changes were made. See
>>
>>cvs log Call.h
>>
>>I suggest that we should not add such comments to source files because
>>they grows the size of the . But any comments that should go to doxygen
>>docs are ok.
>>
>>What do you think about this.
>>
>>you can always see the cvs logs using
>>
>>cvs log <file>
>>
>>Thanks,
>>
>>Susantha
>>---
>>
>>
>>
>>
>
>
>
>
>__________________________________
>Do you Yahoo!?
>New and Improved Yahoo! Mail - Send 10MB messages!
>http://promotions.yahoo.com/new_mail
>
>
--
The best way to predict the future is to invent it - Alan Kay
Re: Adding modification comments to source files
Posted by Samisa Abeysinghe <sa...@yahoo.com>.
I did this because Xerces has it and because it makes easy to see what changes made.
Samisa...
--- Susantha Kumara <su...@opensource.lk> wrote:
> Hi all,
>
> I have seen that we have recently started adding comments to source
> files like
>
> /*
> * Revision 1.3 2004/05/xx <developer name>
> * Some description about the modification done
> */
>
> I also see that the Revision mentioned in many of these comments is not
> the revision to which that changes were made. See
>
> cvs log Call.h
>
> I suggest that we should not add such comments to source files because
> they grows the size of the . But any comments that should go to doxygen
> docs are ok.
>
> What do you think about this.
>
> you can always see the cvs logs using
>
> cvs log <file>
>
> Thanks,
>
> Susantha
> ---
>
>
__________________________________
Do you Yahoo!?
New and Improved Yahoo! Mail - Send 10MB messages!
http://promotions.yahoo.com/new_mail