[RFC|Accepted] Coding Guideline Modifications

[imkingdavid]

Also, one thing I noticed we do with docblocks that is different from the example at the link you posted, and I'm not sure how strict this is, but we don't add a space in front of the * to line them up. So instead of:

Code: Select all

/**
 *
 *
 */

We do:

Code: Select all

/**
*
*
*/

[naderman]

Yup, I'm not sure why we do. I don't really have a preference either way. Anyone else have any thoughts on that?

[imkingdavid]

Yup, I'm not sure why we do. I don't really have a preference either way. Anyone else have any thoughts on that?

Since we already do it without the space, we might as well be consistent and continue to not do it, at least with the 3.x line and then if we want to we can switch for 4.0.

[Noxwizard]

Since I've seen it come up in multiple PR reviews, perhaps the request to have a space after descriptive // style comments should be added to the coding guidelines.

[imkingdavid]

Since I've seen it come up in multiple PR reviews, perhaps the request to have a space after descriptive // style comments should be added to the coding guidelines.

Yes, in general, it is much better to have:

Code: Select all

// this

instead of

Code: Select all

//this

The first one looks better IMO and is easier to read. If that is not already in the coding guidelines, IMO it should be added.

[callumacrae]

Capital letter!

[brunoais]

Capital letter!

I didn't understand

[imkingdavid]

Capital letter!

I didn't understand

He was saying that my examples (//this and // this) should start with capital letters like // This.

[Oleg]

Also, one thing I noticed we do with docblocks that is different from the example at the link you posted, and I'm not sure how strict this is, but we don't add a space in front of the * to line them up. So instead of:

Code: Select all

/**
 *
 *
 */

We do:

Code: Select all

/**
*
*
*/

I find the current style just fine.

[imkingdavid]

Also, one thing I noticed we do with docblocks that is different from the example at the link you posted, and I'm not sure how strict this is, but we don't add a space in front of the * to line them up. So instead of:

Code: Select all

/**
 *
 *
 */

We do:

Code: Select all

/**
*
*
*/

I find the current style just fine.

As do I. I was simply pointing out the difference.