Re: cfscript based components formatting
On Mon, Nov 15, 2010 at 7:18 PM, Sean Corfield wrote: ... (it doesn't affect my position that comments should never change the semantics of code - although, as noted by Ray, the example given only affects metadata so it would only affect the semantics of a program that tested that metadata... in other words, it could still change the behavior of code!) I like JavaDoc. =) Something just strikes me as weird when I see hint=a lot of stuff, maybe even hyperlinks and you know, * bullets * and * whatnot, all sorta mixed in there. I like the idea of going with something that works with the semantics of the ultimate program, the programmer. Maybe other people don't mind that kind of thing though. Yes, JavaDoc rocks, IMHO. =) :Den -- Man is a wingless animal with two feet and flat nails. Plato ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339344 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
Sorry - what? On Mon, Nov 15, 2010 at 10:33 PM, Andrew Scott andr...@andyscott.id.au wrote: No annotations in the comments was mentioned to be slower than using the other way. Regards, Andrew Scott http://www.andyscott.id.au/ ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339278 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
cfscript based components formatting
Hey CFers
This might be a silly question: how are you all formatting your cfcsript
based cfcs? Using annotations or defining the attributes in the method
itself? EG:
// methodOne
*public* boolean *function* foo()
displayname=I am Foo
description=I return a boolean value. I am for testing.
hint=I return a boolean value.{
*return* 1;
}
/**
*...@hint I return an empty structure.
*...@displayname Bar
*...@description I return an empty structure.
*/
*public* struct *function* bar() {
*return* *structNew*();
}
~|
Order the Adobe Coldfusion Anthology now!
http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion
Archive:
http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339239
Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm
Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
I go with the first route as Sean Corfield has made what I consider to
be a very excellent point, which is that comments should never have
effect on the executing code. Comments are for documentation only.
Judah
On Mon, Nov 15, 2010 at 10:15 AM, John Allen johnfal...@gmail.com wrote:
Hey CFers
This might be a silly question: how are you all formatting your cfcsript
based cfcs? Using annotations or defining the attributes in the method
itself? EG:
// methodOne
*public* boolean *function* foo()
displayname=I am Foo
description=I return a boolean value. I am for testing.
hint=I return a boolean value.{
*return* 1;
}
/**
*...@hint I return an empty structure.
*...@displayname Bar
*...@description I return an empty structure.
*/
*public* struct *function* bar() {
*return* *structNew*();
}
~|
Order the Adobe Coldfusion Anthology now!
http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion
Archive:
http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339243
Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm
Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
No comments driving behavior! :-) ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339246 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
/* This is me agreeing */ I agree! On Mon, Nov 15, 2010 at 3:35 PM, Matt Quackenbush quackfu...@gmail.comwrote: No comments driving behavior! :-) ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339247 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
I agree too - although in this case the comments just impact metadata. displayname/description/hint are only used in auto-display. On Mon, Nov 15, 2010 at 4:42 PM, Charlie Griefer charlie.grie...@gmail.com wrote: /* This is me agreeing */ I agree! On Mon, Nov 15, 2010 at 3:35 PM, Matt Quackenbush quackfu...@gmail.comwrote: No comments driving behavior! :-) ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339249 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
RE: cfscript based components formatting
Method one, there is a performance hit when using notations.
Regards,
Andrew Scott
http://www.andyscott.id.au/
-Original Message-
From: John Allen [mailto:johnfal...@gmail.com]
Sent: Tuesday, 16 November 2010 5:16 AM
To: cf-talk
Subject: cfscript based components formatting
Hey CFer's
This might be a silly question: how are you all formatting your cfcsript
based
cfc's? Using annotations or defining the attributes in the method itself?
EG:
// methodOne
*public* boolean *function* foo()
displayname=I am Foo
description=I return a boolean value. I am for testing.
hint=I return a boolean value.{
*return* 1;
}
/**
*...@hint I return an empty structure.
*...@displayname Bar
*...@description I return an empty structure.
*/
*public* struct *function* bar() {
*return* *structNew*();
}
~|
Order the Adobe Coldfusion Anthology now!
http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion
Archive:
http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339250
Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm
Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
Thanks for the advice.
I like method one.
On Mon, Nov 15, 2010 at 5:58 PM, Andrew Scott andr...@andyscott.id.auwrote:
Method one, there is a performance hit when using notations.
Regards,
Andrew Scott
http://www.andyscott.id.au/
-Original Message-
From: John Allen [mailto:johnfal...@gmail.com]
Sent: Tuesday, 16 November 2010 5:16 AM
To: cf-talk
Subject: cfscript based components formatting
Hey CFer's
This might be a silly question: how are you all formatting your cfcsript
based
cfc's? Using annotations or defining the attributes in the method itself?
EG:
// methodOne
*public* boolean *function* foo()
displayname=I am Foo
description=I return a boolean value. I am for testing.
hint=I return a boolean value.{
*return* 1;
}
/**
*...@hint I return an empty structure.
*...@displayname Bar
*...@description I return an empty structure.
*/
*public* struct *function* bar() {
*return* *structNew*();
}
~|
Order the Adobe Coldfusion Anthology now!
http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion
Archive:
http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339252
Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm
Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
On Mon, Nov 15, 2010 at 2:58 PM, Andrew Scott andr...@andyscott.id.au wrote: Method one, there is a performance hit when using notations. Is there? Why so? (it doesn't affect my position that comments should never change the semantics of code - although, as noted by Ray, the example given only affects metadata so it would only affect the semantics of a program that tested that metadata... in other words, it could still change the behavior of code!) -- Sean A Corfield -- (904) 302-SEAN Railo Technologies, Inc. -- http://getrailo.com/ An Architect's View -- http://corfield.org/ If you're not annoying somebody, you're not really alive. -- Margaret Atwood ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339258 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
RE: cfscript based components formatting
Don't do that to me Sean, I was actually quoting something you said on something similar to this some months ago. Are you saying there isn't now? Regards, Andrew Scott http://www.andyscott.id.au/ -Original Message- From: Sean Corfield [mailto:seancorfi...@gmail.com] Sent: Tuesday, 16 November 2010 1:18 PM To: cf-talk Subject: Re: cfscript based components formatting On Mon, Nov 15, 2010 at 2:58 PM, Andrew Scott andr...@andyscott.id.au wrote: Method one, there is a performance hit when using notations. Is there? Why so? (it doesn't affect my position that comments should never change the semantics of code - although, as noted by Ray, the example given only affects metadata so it would only affect the semantics of a program that tested that metadata... in other words, it could still change the behavior of code!) -- Sean A Corfield -- (904) 302-SEAN Railo Technologies, Inc. -- http://getrailo.com/ An Architect's View -- http://corfield.org/ ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339262 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
Re: cfscript based components formatting
I would assume _any_ metadata would make parsing the CFC slower. So this: cffunction name=foo a=1 b=2 c=3 is slower than cffunction name=foo However - I'd question if it was _significantly_ slower. My guess would be no. I'd imagine the 'slower' one would be 1ms slower probably. On Mon, Nov 15, 2010 at 9:01 PM, Andrew Scott andr...@andyscott.id.au wrote: Don't do that to me Sean, I was actually quoting something you said on something similar to this some months ago. Are you saying there isn't now? Regards, Andrew Scott http://www.andyscott.id.au/ -Original Message- From: Sean Corfield [mailto:seancorfi...@gmail.com] Sent: Tuesday, 16 November 2010 1:18 PM To: cf-talk Subject: Re: cfscript based components formatting On Mon, Nov 15, 2010 at 2:58 PM, Andrew Scott andr...@andyscott.id.au wrote: Method one, there is a performance hit when using notations. Is there? Why so? (it doesn't affect my position that comments should never change the semantics of code - although, as noted by Ray, the example given only affects metadata so it would only affect the semantics of a program that tested that metadata... in other words, it could still change the behavior of code!) -- Sean A Corfield -- (904) 302-SEAN Railo Technologies, Inc. -- http://getrailo.com/ An Architect's View -- http://corfield.org/ ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339264 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
RE: cfscript based components formatting
No annotations in the comments was mentioned to be slower than using the other way. Regards, Andrew Scott http://www.andyscott.id.au/ -Original Message- From: Raymond Camden [mailto:rcam...@gmail.com] Sent: Tuesday, 16 November 2010 2:56 PM To: cf-talk Subject: Re: cfscript based components formatting I would assume _any_ metadata would make parsing the CFC slower. So this: cffunction name=foo a=1 b=2 c=3 is slower than cffunction name=foo However - I'd question if it was _significantly_ slower. My guess would be no. I'd imagine the 'slower' one would be 1ms slower probably. ~| Order the Adobe Coldfusion Anthology now! http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:339268 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm
