Permalink
Browse files

more comments added to .vimrc example

  • Loading branch information...
miura committed Nov 11, 2012
1 parent a5f2c0f commit a21627756eb154ba9aed7fdfd01c2aa9cb397fe7
Showing with 9 additions and 8 deletions.
  1. +9 −8 README.md
View
@@ -66,28 +66,29 @@ Vim completion
Setting examples
```vim
-" Disable AutoComplPop.
+" Disable AutoComplPop. Comment out this line if AutoComplPop is not installed.
let g:acp_enableAtStartup = 0
-" Use neocomplcache.
+" Launches neocomplcache automatically on vim startup.
let g:neocomplcache_enable_at_startup = 1
" Use smartcase.
let g:neocomplcache_enable_smart_case = 1
" Use camel case completion.
let g:neocomplcache_enable_camel_case_completion = 1
-" Use underbar completion.
+" Use underscore completion.
let g:neocomplcache_enable_underbar_completion = 1
-" Set minimum syntax keyword length.
+" Sets minimum char length of syntax keyword.
let g:neocomplcache_min_syntax_length = 3
+" buffer file name pattern that locks neocomplcache. e.g. ku.vim or fuzzyfinder
let g:neocomplcache_lock_buffer_name_pattern = '\*ku\*'
-" Define dictionary.
+" Define file-type dependent dictionaries.
let g:neocomplcache_dictionary_filetype_lists = {
\ 'default' : '',
\ 'vimshell' : $HOME.'/.vimshell_hist',
\ 'scheme' : $HOME.'/.gosh_completions'
\ }
-" Define keyword.
+" Define keyword, for minor languages
if !exists('g:neocomplcache_keyword_patterns')
let g:neocomplcache_keyword_patterns = {}
endif
@@ -123,14 +124,14 @@ inoremap <expr><C-e> neocomplcache#cancel_popup()
"inoremap <expr><TAB> pumvisible() ? "\<Down>" : "\<TAB>"
"inoremap <expr><CR> neocomplcache#smart_close_popup() . "\<CR>"
-" Enable omni completion.
+" Enable omni completion. Not required if they are already set elsewhere in .vimrc
autocmd FileType css setlocal omnifunc=csscomplete#CompleteCSS
autocmd FileType html,markdown setlocal omnifunc=htmlcomplete#CompleteTags
autocmd FileType javascript setlocal omnifunc=javascriptcomplete#CompleteJS
autocmd FileType python setlocal omnifunc=pythoncomplete#Complete
autocmd FileType xml setlocal omnifunc=xmlcomplete#CompleteTags
-" Enable heavy omni completion.
+" Enable heavy omni completion, which require computational power and may stall the vim.
if !exists('g:neocomplcache_omni_patterns')
let g:neocomplcache_omni_patterns = {}
endif

0 comments on commit a216277

Please sign in to comment.