Tự động quản lý tiêu đề giấy phép/tác giả/phiên bản trong các tệp nguồn

Question

Thường được coi là thực hành tốt để thêm một số dòng với thông tin tác giả, phiên bản và giấy phép vào đầu tệp nguồn. Ví dụ, Gnu GPL v3 gợi ý thêm

<one line to give the program's name and a brief idea of what it does.> 
Copyright (C) <year> <name of author> 

This program is free software: you can redistribute it and/or modify 
it under the terms [SNIP] 

tôi thấy nó tẻ nhạt để thêm nó bằng tay đến từng file và phải cập nhật tất cả tất cả bây giờ và sau đó khi một số này thay đổi thông tin (tác giả mới, bản quyền năm, phiên bản va chạm).

Có cách nào để quản lý điều này tự động không, để tôi chỉ phải chỉnh sửa nội dung này ở một nơi và được sao chép tự động xung quanh?

Nếu cần, bạn có thể giả định rằng tôi đang sử dụng bất kỳ hệ thống kiểm soát sửa đổi hiện đại nào.

Answer 1

Thường được coi là thực hành tốt để thêm một số dòng với thông tin tác giả, phiên bản và giấy phép vào đầu tệp nguồn.

Điều đó tùy thuộc. Trước hết có hai (và nhiều hơn nữa) cách để làm điều này:

• quản lý thông tin cấp phép cho mỗi tập tin
• quản lý thông tin cấp phép trong một vị trí trung tâm.

Nếu bạn bắt đầu dự án từ đầu, phương pháp mỗi tệp thường dễ thực hiện trong khi vẫn giữ mọi thứ rõ ràng. Khi bạn viết, với thời gian nó ngày càng trở nên khó khăn hơn để theo dõi mọi thứ. Vì vậy, ngày càng có nhiều dự án chuyển sang biến thể vị trí trung tâm.

Phương pháp từng tệp có lợi ích là phạm vi công việc rõ ràng. Thường thì bạn viết tên của ứng dụng trong tập tin-bình luận. Nếu một tập tin được lấy ra vì một lý do nào đó, thông tin vẫn còn trong đó và chuỗi tài liệu không bị hỏng.

Với phương pháp vị trí trung tâm, lợi ích là, điều này thường được phần mềm điều khiển phiên bản của bạn hỗ trợ, ví dụ GIT. Các cam kết có thể được ký bởi người đến và tác giả có thể được trao. Đó là tài liệu người đã viết mã tự động và thông tin đó được lưu trữ ở một vị trí trung tâm: VCS.

Giữ tệp COPYING với gói của bạn, nơi bạn cung cấp thông tin chính ở giữa. Bạn có thể dễ dàng tạo danh sách tác giả qua VCS. Và cho mỗi tập tin bạn có thể tạo một tiêu đề, mà chỉ quy định cụ thể mà phần mềm và nơi để xem xét, chỉ là một phác thảo trần:

/** 
* Flux Deluxe v3.2.0 - Vector Drawing Redefined 
* 
* Copyright 2010, 2012 by it's authors. 
* Some rights reserved. See COPYING, AUTHORS. 
*/ 

Nếu bạn phát hành một phiên bản mới trong một năm mới đó là không có trí tuệ để cập nhật tất cả các tệp.

Answer 2

Nếu làm việc với Visual Studio, bạn có thể sử dụng macro và đính kèm lối tắt cho nó. Sau đó, khi tạo một tệp mới, hãy sử dụng lối tắt để thêm tiêu đề. Nếu bạn muốn đảm bảo rằng tiêu đề đã được bao gồm trong mỗi tệp, bạn có thể sử dụng StyleCop.

liên kết sau có thể hữu ích:
http://abhijitjana.net/2010/12/05/add-document-header-for-files-automatically-in-visual-studio/
http://stylecop.codeplex.com/

Trong Eclipse, đó cũng là hỗ trợ vĩ mô, do đó bạn sẽ có thể làm tương tự như đề xuất cho VS. Tuy nhiên, tôi không có bất kỳ kinh nghiệm với điều đó.

Đối với Java, có một thay thế cho StyleCop:
http://stylecop.codeplex.com/

tôi đã không nghe nói về bất kỳ SVN-công cụ điều chỉnh các tập tin riêng của mình. Sử dụng macro trong trình chỉnh sửa của bạn là điều gần nhất với những gì bạn muốn.

Answer 3

Sử dụng License Header Manager