Monday, October 5, 2009

Reasons to NOT put version history in the comments

[This was originally posted at http://timstall.dotnetdevelopersjournal.com/reasons_to_not_put_version_history_in_the_comments.htm]

Some coding standards ask that developers add revision history to the top of the method. Not just the normal "Summary" and "Parameter" tags that can be used to automatically create documentation, but rather a full blown revision log with developer name, date, and comment. This was bigger in the 80's and 90's, when source control and refactoring weren't as common. However, in these days, putting revision history in your comments has some really big problems:
  • Extra effort - It requires extra effort from developers, and usually the tedious kind of effort. It requires manual developer discipline, so architects don't have a good way to enforce this.
  • Bad for refactoring - It discourages refactoring of methods. Say you split a method in two - how do you split up the commented version history?
  • Source control already provides this - It doesn't tell you anything that source control history won't already give you. But even worse, it could be misleading - source control is the true authority, a developer could accidentally type (or forget) the wrong comments. Also, by documenting at the top of the method, it is hard to indicate what changed in the middle (whereas source control diff would instantly tell you).

Perhaps for SQL, I can see the benefit, so that when the DBA runs sp_helptext on a stored proc, they get a quick history (and databases aren't usually refactored like C# code). However, for middle tier code, putting revision history in comments seems like an unwise use of time.

LINK: Comments as version control
 

1 comment:

  1. Chọn mẫu bàn làm việc tạo sự thoải mái cho nhân viên
    Hiện nay trên thị trường nội thất không quá khó khăn để chọn mua mẫu bàn làm việc hòa phát cho văn phòng của mình chính vì thế cho nên việc lựa chọn mua cho văn phòng bạn mẫu bàn như thế nào sao cho phù hợp với nhu cầu và khả năng sử dụng của mình. Chính vì thế hôm nay chúng tôi chia sẻ các bạn cách lựa chọn bàn làm việc như thế nào cho phù hợp.
    Bàn làm việc Hòa Phát được sản xuất từ gỗ công nghiệp Melamine Face Chipboard. Bàn làm việc cps rất nhiều loại với mẫu mã đa dạng, từ đơn giản đến cầu kỳ. Có nhiều kích thước khác nhau phù hợp với diện tích văn phòng.
    Hầu hết các văn phòng công ty không thể thiếu những chiêc bàn làm việc, vậy việc chọn bàn làm việc sao cho vừa bền đẹp lại giá cả hợp lý đảm bảo về chất lượng không phải ai cũng biết? Sau đây nội thất hòa phát xin chia sẻ cho các bạn một số cách chọn bàn làm việc văn phòng tốt nhất.
    Căn cứ vào yếu tố chất liệu mặt bàn, chất liệu mặt bàn rất quan trọng trong quá trình làm việc. Hòa Phát sản xuất và thiết kế ra hàng trăm mẫu bàn văn phòng giá rẻ , từ bàn làm việc đơn giản đến bàn làm việc văn phòng cao cấp. Một số loại bàn làm việc cho bạn tham khảo:
    Bàn làm việc melamine: Mặt bàn dày và mật độ phủ melamine nhiều. Kích thước có sẵn, màu sắc sang trọng, bền bỉ.
    Bàn làm việc đơn giản: Đây là loại bàn phổ biến được nhiều văn phòng sửa dụng, mặt bàn được phủ lớp melamine mỏng. Vệ sinh dễ dàng và có độ bền tốt, giá cả phải chăng, có lẽ loại bàn này giá thành rẻ nhất.
    Bàn làm việc chân sắt
    Bàn làm việc chân sắt có độ bền cao hơn, khả năng chống xước cao. Bàn làm việc chân sắt có khả năng chịu đựng ẩm ướt, di chuyển nhiều. Bàn làm việc chân sắt hiện đang là sản phẩm yêu thích được nhiều văn phòng lựa chọn.

    ReplyDelete