帮酷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  |  如果智培  |  酷兔英语