[Vtigercrm-commits] [vtiger development] #1284: Removal of commented-out code is helpful

vtiger development vtiger-tickets at vtiger.fosslabs.com
Thu Jun 8 11:01:20 EDT 2006


#1284: Removal of commented-out code is helpful
-----------------------+----------------------------------------------------
 Reporter:  jeffk      |       Owner:  developer
     Type:  defect     |      Status:  new      
 Priority:  minor      |   Milestone:  5.0.0    
Component:  vtigercrm  |     Version:  5.0.0    
 Keywords:             |  
-----------------------+----------------------------------------------------
 Just a generalized meta-item following up richie's good work removing
 unused methods as seen in r6972, r6973.

 In addition to removal of unused code, I think we should also remove
 commented-out code from the codebase when encountering it:

  - Code removed is code that can't have bugs.
  - Commented lines suffer bit-rot from lack of  API updates, etc.
  - PHP comment blocks are easy to accidentally uncomment, another source
 of bugs.

 Subversion's support for merging changesets encourages removal of unwanted
 code, because you'll always be able to bring it back in-place.

 The only thing you need to do is make a clearly worded note of it in the
 commit message, and optionally document code removal via a trac ticket.

 Commit messages and trac tickets are searchable resources, and properly
 documented, removal of commented code won't prevent us from finding the
 old code if we need it.

-- 
Ticket URL: <http://vtiger.fosslabs.com/cgi-bin/trac.cgi/ticket/1284>
vtiger development <http://vtiger.fosslabs.com/>
vtigerCRM


More information about the vtigercrm-commits mailing list