Commenting Service

What special methods do you use when modifying existing code?

For example: say that you are modifying a business rule inside a method. Do you mark the changed section with special comments?

What coding / commenting standards do you use when changing code?

+5
source share
10 answers

You mean something like:

foo();  // changed by SecretWiz, 20090131

I would not recommend this. It clutters the code files, and a version control system should handle this for you. He keeps track of who has changed what. Use

svn blame
+14
source

- , , , , , , , ( - , - ;-), .

+4

, , - ( ) , . - ". / bugzilla ". . , , , / . , -.

+3

, . . - , . , :

// modified by A.B. on 11/23/99 to fix issue #123456

, . , , .., № 123456? , , - ?

.

+2

.
, , / .

. GiveRebateIfValidCoupon();

+1

" / ?"

. . , , .

-.

0

, , - , . (, TEMPFIX), . , , , , , , , .

, .

0

, , .

, , , - ​​ , , , .

, , , , refactor . , , .

, ( ).

0

. , .

, , , .. , . . , , , , . - , , , , , .

0

, SO. " - , ". , , , - . - , , , , .

, , , 10 000 .

0

All Articles