Incorrect comments set for php in vim

Question

My vim used to auto-continue comments in php. For example:

/* |  <- cursor here

Then, pressing Enter gives me:

/*
 * |  <- cursor here

and again, gives me:

/*
 *
 * |  <- cursor here

etc...

As far as I understand it, this is controlled by the comments and formatoptions options. However, whenever I open a php file now, comments is set to:

s:

I've looked all over my ~/.vim folder, as well as the $VIMRUNTIME folder, and I can't find out where/why this changed, and why the comments option is being set incorrectly.

Here's a link to my .vimrc

http://pastebin.com/f1509ce65

Community · Accepted Answer · 2020-06-20 09:12:55Z

8

Note.

Note that this issue can also arise if one have filetype indent on and plugin on at separate lines in .vimrc:

filetype indent on
filetype plugin on

This causes $VIMRUNTIME/indent/php.vim to be processed before $VIMRUNTIME/ftplugin/php.vim.

The indent/php.vim file resets 'comments', but ftplugin/php.vim does not.

Order of mess:

indent/php.vim get sourced and comments correctly set:

setlocal comments=s1:/*,mb:*,ex:*/,://,:#

Then ftplugin/php.vim get sourced. It again sources ftplugin/html.vim by:

runtime! ftplugin/html.vim ftplugin/html_*.vim ftplugin/html/*.vim

which result in ftplugin/html.vim being processed and setting:

setlocal commentstring=<!--%s-->
setlocal comments=s:<!--,m:\ \ \ \ ,e:-->

Later on in ftplugin/php.vim the commentstring is reset but not comments:

setlocal commentstring=/*%s*/

Fix:

filetype indent plugin on

" Or
filetype plugin indent on

" Or with correct order:
filetype plugin on
filetype indent on

PS.

In any case plugin should be processed before indent.

To check order of inclusion/processing have a look at :scriptnames.

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Sep 28, 2014 at 19:30

user13500

3,8642 gold badges29 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

jrebs Over a year ago

Although Lekensteyn offers a workaround that should patch the issue, this response seems to identify the underlying cause. When I make a single line in vimrc with filetype plugin indent on, then my comments value is correct when I load a PHP buffer without having to hijack the comments value manually.

Community · Accepted Answer · 2017-03-20 10:18:24Z

3

With the default settiings of version 7.3 (patchset 754), I observe the same bug as in your original post:

/**<ENTER>

Expected result:

/**
 * <cursor>

Actual result:

/**
<cursor>

The solution consists of two steps:

Add a command that makes vim detect comments (see Issue 75 for vim on Google Code)
Add a command that makes vim automatically insert comment continuations (apply the reverse of Vim: can I disable continuation of comments to the next line?)

The modification to my vimrc that takes these two steps into account:

au FileType php setlocal comments=s1:/*,mb:*,ex:*/,://,:#
au FileType php setlocal formatoptions+=cro

Hurrah!

edited Mar 20, 2017 at 10:18

CommunityBot

11 silver badge

answered Jan 25, 2013 at 22:40

Lekensteyn

67k25 gold badges169 silver badges205 bronze badges

1 Comment

user13500 Over a year ago

As you say "With the default settings" it might not be the case, but sure it is not due to wrong order of indent and plugin? Ref. my own answer.

rossipedia · Accepted Answer · 2010-01-18 17:17:04Z

1

Found it. I had a funky .vim/indent/php.vim file that somehow was screwing it up.

Deleted it, and the functionality I was looking for returned. Thanks tho!

answered Jan 18, 2010 at 17:17

rossipedia

59.8k10 gold badges95 silver badges94 bronze badges

Comments

John Weldon · Accepted Answer · 2010-01-14 02:26:32Z

0

The php.vim file should be in your ftplugin folder in $VIMRUNTIME.

In version 7.2 of vim, the comments line is line 74 in that file.

Did that file get deleted or moved?

answered Jan 14, 2010 at 2:26

John Weldon

40.9k11 gold badges98 silver badges132 bronze badges

2 Comments

rossipedia Over a year ago

No, it's still there. Maintainer: Dan Sharp URL: dwsharp.users.sourceforge.net/vim/ftplugin

John Weldon Over a year ago

do you have any files in your personal .vim/ftplugin that could be overriding the comments? Or your .vim/filetype.vim for that matter?

Collectives™ on Stack Overflow

Incorrect comments set for php in vim

4 Answers 4

Note.

Order of mess:

Fix:

PS.

1 Comment

1 Comment

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Note.

Order of mess:

Fix:

PS.

1 Comment

1 Comment

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related