帮酷LOGO
  • 显示原文与译文双语对照的内容
Build your commit message in the comments of your code

  • 源代碼名稱:commit-comments
  • 源代碼網址:http://www.github.com/thebearjew/commit-comments
  • commit-comments源代碼文檔
  • commit-comments源代碼下載
  • Git URL:
    git://www.github.com/thebearjew/commit-comments.git
  • Git Clone代碼到本地:
    git clone http://www.github.com/thebearjew/commit-comments
  • Subversion代碼到本地:
    $ svn co --depth empty http://www.github.com/thebearjew/commit-comments
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • 提交註釋

    提交註釋自動從代碼中的註釋創建項目符號列表。 在 @commit 關鍵字中寫註釋,當提交時,它們將被添加到提交消息中。

    它通過使用兩個 Git鉤子 ( 英鎊 prepare-commit-m 和英鎊POST提交成本) 來搜索存儲庫,並構造一個乾淨的更改列表。

    成功提交后,@commit 註釋將從你的文件中刪除

    安裝

    克隆存儲庫並移動 prepare-commit-msgpost-commit 文件。

    $ git clone https://github.com/thebearjew/commit-comments.git
    $ cd commit-comments
    $ chmod a+x prepare-commit-msg post-commit
    $ cp prepare-commit-msg post-commit your-repository/.git/hooks 

    用法

    在編寫代碼時,在發生重大更改的地方放置 //@commit 註釋。

    提交評論使用( 內聯&獨立):

    • c 像註釋( c/C++,Java,JavaScript,等等 ) ///* */
    • Python/Ruby/Perl #
    • 程序集 ;

    例如:

    foo.js// @commit: Added a parameter to helloWorld functionfunctionhelloWorld(phrase) {
     console.log('Hello World + '+ phrase); /* @commit - Concatenated strings */}

    Git提交消息中的輸出

    # Commit title goes here
    - [foo.js#1] Added a parameter to helloWorld function
    - [foo.js#3] Concatenated strings
    # Changes to be committed:
    # modified: foo.js 
    #
    # Changes not staged for commit:
    #.. .

    從原始文件中刪除註釋。

    foo.js- after commitfunctionhelloWorld(phrase) {
     console.log('Hello World + '+ phrase); 
    }

    忽略文件

    要忽略搜索的某些文件,請在存儲庫中創建一個 .ccignore 文件並添加文件名/類型。

    README.md
    build.sh
    .cpp

    依賴項

    • commit中刪除註釋需要花費的。

    在 Mac OS X 上,默認的sed來自FreeBSD發行版。 要下載 GNU sed版本,請使用

    $ brew install gnu-sed --with-default-names

    如果沒有 --with-default-names 選項,命令將被下載為 gsed

    • pcregrep 是主要的搜索工具,因為它具有廣泛的可移植性。

    如果pcregrep不可用,則使用(。對於 Perl 正規表達式 &變數回溯)。

    提供 & Todo

    有助於提高簡單/解決兼容性的貢獻。 如果有有用的改進。技巧或者攻擊,請提交請求請求和 add-ons 和Fragment目錄將被創建。

    待辦事項

    • 向項目符號提交 commets - 建議添加文件名和行號( joncalhoun )
    • 用戶 git diff --cached --name-status --diff-filter=ACM 代替 git ls-files
    • 開發更多的測試用例( 用grep表達式查找邊緣案例)
    • 將sed命令重寫為 POSIX ( BSD ) 兼容 正規表達式
    • 創建更健壯的正則表達式來驗證註釋語法
      • 檢查多行 block 註釋
      • 檢查關閉註釋符號( 正外觀 aheads )
    • 編程語言
      • HTML
      • Fortran
      • AppleScript

    - -

    特別感謝Bryan的反饋和 Bug 修正- @brwyatt




    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语