sponsor Vim development Vim logo Vim Book Ad

CodeCommenter : Code Comment Assistant

 script karma  Rating -2/2, Downloaded by 444    Comments, bugs, improvements  Vim wiki

created by
xiang jiujiu
 
script type
utility
 
description
codecommenter - Code Comment Assistant

Language:    Php, Python, Js, Java, C, C#, C++
Maintainer:   九九 <xjiujiu@foxmail.com>
License:      BSD New
Requires:     Vim >= 7.2
Last Change:  2012-02-17
Version:      1.0.0

Installation
------------

1. Place this file and ipyqtmacvim.scpt in ~/.vim/plugins/

2. Place the following line in your .vimrc (requires Vim >= 7.2)
"//////////////////////////////////////////
"Config your commenter items
let g:myCodeCommenterConfigItems  = {
            \ 'author': 'xjiujiu',                                 ==> To config the author of these code
            \ 'siteUrl': 'http://www.xjiujiu.com',         ==> To config the site of the author
            \ 'email': 'xjiujiu@foxmail.com',             ==> To config the email of the author
            \ 'linsence': 'BSD NEW',                       ==> To config the code linsence
            \ 'copyRight': 'Copyright (c) 2011-2012 http://www.xjiujiu.com.All right reserved',    ==> To config the copyright information
            \ 'companyName': 'HongJuZi',                ==> Your company name
            \ 'projectDecription': 'HongJuZi Framework',   ==> To config the decsription of the project
            \ 'versionBySvn': 1                                ==> To config the version of the file is gen by subversion or by the script function
"            \ }
   This enables Vim to use your system clipboard.
  
3. If desired, configure the hotkeys to run codeCommenter.The default hotkey is <Ctrl-M>

Examples
--------------
" Version: $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $
///////////////////////////////////
//f - <Ctrl-M>
"""
" @Version $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $
" @Package None
" @Subpackage None
" @CopyRight Copyright (c) 2011-2012 http://www.xjiujiu.com.All right reserved
"
"""
/**
* @Version $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $
* @Package: None
* @Subpackage: None
* @CopyRight: Copyright (c) 2011-2012 http://www.xjiujiu.com.All right reserved
* @License: Apache GNU
*
*/
//////////////////////////////////////////
//c - <Ctrl-M>
"""
" @point
"
" @desc
"
" @Author 九九 <xjiujiu@foxmail.com>
" @Package None
" @Version $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $
"""

/**
* @point
*
* @desc
*
* @Author 九九 <xjiujiu@foxmail.com>
* @Package None
* @Version $Id: test-codecommenter.vim 74 2012-02-17 01:45:19Z xjiujiu@gmail.com $
*/
//////////////////////////////////////////
//m - <Ctrl-M>
/**
* @point
*
* @desc
*
* @Access public
* @Param string test
* @Param  int yes
* @Return void
* @Exception none
*/

"""
" @point
"
" @desc
"
" @Access public
" @Param string test
" @Param  int yes
" @Return void
" @Exception none
"""
function GetName(string test, int yes)
endfunction
//////////////////////////////////////////
//v - <Ctrl-M>
/**
* var $string    
*/

"""
" var
"""
let var = 1
$string     = "test"
//////////////////////////////////////////


Troubleshooting
---------------
/**
* The file type can't be supported!
*/
This means you file type can't be supported now!
:(

Contact
-------

xjiujiu at xjiujiu@foxmail.com

Linux OS Notice
-------
You need to change the enter mode.Please use dos2unix tool to do this.Example:
dos2unix YourPath/codecommenter.vim
 
install details
Copy the codecommenter.vim to {your_vim_path}/plugins/codecommenter.vim
Done.
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
codecommenter.vim 2.0 2013-11-20 7.0 xiang jiujiu 1. Add InhertDoc comment
>>Example:
    //i -> C-M    (CTRL + M)
    /**
     * @point
     *
     * @desc
     *
     * {@inheritdoc}
     *
     * @author xjiujiu <xjiujiu@foxmail.com>
     */

2. Fixed PHP Doc Tags
3. Fixed Some Bugs.
codecommenter.vim 2.0 2013-11-20 7.0 xiang jiujiu 1. Add InhertDoc comment
>>Example:
    //i -> C-M    (CTRL + M)
    /**
     * @point
     *
     * @desc
     *
     * {@inheritdoc}
     *
     * @author xjiujiu <xjiujiu@foxmail.com>
     */

2. Fixed PHP Doc Tags
3. Fixed Some Bugs.
codecommenter.vim 2.0 2013-11-20 7.2 xiang jiujiu 1. Add InhertDoc comment
>>Example:
    //i -> C-M    (CTRL + M)
    /**
     * @point
     *
     * @desc
     *
     * {@inheritdoc}
     *
     * @author xjiujiu <xjiujiu@foxmail.com>
     */

2. Fixed PHP Doc Tags
3. Fixed Some Bugs.
codecommenter.vim 2.0 2013-11-20 7.2 xiang jiujiu 1. Add InhertDoc comment
>>Example:
    //i -> C-M    (CTRL + M)
    /**
     * @point
     *
     * @desc
     *
     * {@inheritdoc}
     *
     * @author xjiujiu <xjiujiu@foxmail.com>
     */

2. Fixed PHP Doc Tags
3. Fixed Some Bugs.
codecommenter.vim 2.0 2013-11-20 7.2 xiang jiujiu 1. Add InhertDoc comment
>>Example:
    //i -> C-M    (CTRL + M)
    /**
     * @point
     *
     * @desc
     *
     * {@inheritdoc}
     *
     * @author xjiujiu <xjiujiu@foxmail.com>
     */

2. Fixed PHP Doc Tags
3. Fixed Some Bugs.
codecommenter.vim 1.2.0 2012-10-25 7.3 xiang jiujiu 1. Fix some Bugs;
2. Clear some comment items.
codecommenter.vim 1.0.1 2012-02-24 7.2 xiang jiujiu 1. Add a new feature——autoindent the comment line,such as:
    //f  -> <Ctrl + M>
    """
     " @Version $Id$
     " @Package None
     " @Subpackage None
     " @CopyRight Copyright (c) 2011-2012 http://www.xjiujiu.com.All right reserved
     "
    """
2. Fix some bugs.
codecommenter.vim 1.0.0 2012-02-17 7.2 xiang jiujiu The First Version.Welcome to commit the bugs :)  <xjiujiu@foxmail.com>
ip used for rating: 54.81.76.147

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
SourceForge.net Logo