esuna icon indicating copy to clipboard operation
esuna copied to clipboard

What do you think about comments naming convention

Open Idered opened this issue 12 years ago • 2 comments

Please see documentation first.

Now some screens of how comments works with Sublime Text Goto symbol function:

Section comments:

Trigger: $

/** $Forms */
/*---------------------------------------------------------------------------*/

Object comments:

Trigger: %  

/** %Site nav */
/*------------------------------------*/

Trigger: %[ 

/** %[min480] Site nav */
/*------------------------------------*/

Trigger: [

/** [Base] Links */
/*------------------------------------*/

Trigger: [form

/** [Form] Basic structure */
/*------------------------------------*/

Trigger: =

/** =Phones */
/*------------------------------------*/

You can play with it too, just open style.css in Sublime Text, press ctrl/cmd + r and try one of examples mentioned before. Sublime snippets for this comments can be found here

I would like to know what you guys think about this. Any more room to improve or those comments are too complicated?

Idered avatar Mar 26 '13 12:03 Idered

I’ve just played with it a little bit and I must admit this is damn brilliant idea. If I used it in a project I would probably make some cheat sheet with signs for objects, triggers, etc. It’s not too complicated, it’s probably as simple as it could be.

Also: these snippets are probably going to be useful when not working with Esuna too. Let me star them for later :)

Keep up the good work, I do believe this is going to be widely recognized framework one day. Maybe it won’t be as big as Bootstrap, but I am sure there’s still room for new frameworks with fresh ideas :)

Piotrek

pim avatar Mar 26 '13 13:03 pim

@pim Thanks, good to know that other devs likes it too. It's a rought draft and might change in meantime but I quite like it as it is now :)

Idered avatar Mar 26 '13 16:03 Idered