RE: [Flashcoders] Flash/Actionscript Coding conventions
Surely this is just a matter of using a fully featured IDE to develop your code in - if you use Flashdevelop for instance you can block comment/uncomment any lines/lines using // syntax from the edit menu with comment line, or with keyboard shortcuts - this will not conflict with block comments /**/ and therefore you will no longer have a problem. Life once more is wonderful. M -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Steven Sacks | BLITZ Sent: 24 August 2006 02:19 To: Flashcoders mailing list Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions why does adding block comments to your code ruin it? I still don't understand how Javadoc makes your process suffer. From my first post: Commenting like that in your code makes it completely impossible to easily and completely comment out blocks of code using /* */ because they have their */ inside their comments. Believe it or not, this is a very important tool in debugging. If somebody wrote something completely impenetrable and I'm in charge of implementing it and it doesn't work, guess what? I rewrite it or I make them fix it. I'm not saying documentation isn't important, I'm saying mucking up your code with documentation in Actionscript by using Javadoc's requirements is counterproductive to Flash development. If Javadoc let me use line comments instead of block comments I would have no issue. ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
So you're saying I need to use a third party tool to overcome an issue created by another third party tool? Where does it end? WHERE...DOES...IT...END? :) -Original Message- From: [EMAIL PROTECTED] [mailto:flashcoders- [EMAIL PROTECTED] On Behalf Of Mike Mountain Sent: Thursday, August 24, 2006 2:35 AM To: Flashcoders mailing list Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions Surely this is just a matter of using a fully featured IDE to develop your code in - if you use Flashdevelop for instance you can block comment/uncomment any lines/lines using // syntax from the edit menu with comment line, or with keyboard shortcuts - this will not conflict with block comments /**/ and therefore you will no longer have a problem. Life once more is wonderful. M -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Steven Sacks | BLITZ Sent: 24 August 2006 02:19 To: Flashcoders mailing list Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions why does adding block comments to your code ruin it? I still don't understand how Javadoc makes your process suffer. From my first post: Commenting like that in your code makes it completely impossible to easily and completely comment out blocks of code using /* */ because they have their */ inside their comments. Believe it or not, this is a very important tool in debugging. If somebody wrote something completely impenetrable and I'm in charge of implementing it and it doesn't work, guess what? I rewrite it or I make them fix it. I'm not saying documentation isn't important, I'm saying mucking up your code with documentation in Actionscript by using Javadoc's requirements is counterproductive to Flash development. If Javadoc let me use line comments instead of block comments I would have no issue. ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
It ends when you make your own damn third-party tools! ;) Seriously, though, I don't find that I have to comment out huge swaths of class functions at a time very often. Even if I did have to comment out several functions, they might not be next to each other, anyway. And, as I said before, commenting out a single function is *easier* when each one is preceded by a block comment--one keystroke of backspace or delete (unless it's the very last function). Finally, nothing about Javadoc precludes you from using block comments inside function bodies. Have you actually tried Javadoc or is this dislike preemptive? -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Steven Sacks | BLITZ Sent: Thursday, August 24, 2006 9:58 AM To: Flashcoders mailing list Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions So you're saying I need to use a third party tool to overcome an issue created by another third party tool? Where does it end? WHERE...DOES...IT...END? :) ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
I have an issue with coders who put block comments in the middle of
their code, such as:
/***
** SOME COMMENTS
**/
function foo() {
trace(hello world);
}
Or even worse:
/***
** SOME COMMENTS
**/
function foo() {
/* some comments inside the code */
trace(hello world);
}
People who comment like that are my bane and here is why. Commenting
like that in your code makes it completely impossible to easily and
completely comment out blocks of code using /* */ because they have
their */ inside their comments. Believe it or not, this is a very
important tool in debugging.
So, please do everyone a favor and only use block comments before and
after your code and use line comments // for all comments inside your
code. :)
Thanks,
Steven
___
Flashcoders@chattyfig.figleaf.com
To change your subscription options or search the archive:
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Brought to you by Fig Leaf Software
Premier Authorized Adobe Consulting and Training
http://www.figleaf.com
http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
Steven Sacks | BLITZ wrote:
I have an issue with coders who put block comments in the middle of
their code, such as:
/***
** SOME COMMENTS
**/
function foo() {
trace(hello world);
}
Or even worse:
/***
** SOME COMMENTS
**/
function foo() {
/* some comments inside the code */
trace(hello world);
}
People who comment like that are my bane and here is why. Commenting
like that in your code makes it completely impossible to easily and
completely comment out blocks of code using /* */ because they have
their */ inside their comments. Believe it or not, this is a very
important tool in debugging.
So, please do everyone a favor and only use block comments before and
after your code and use line comments // for all comments inside your
code. :)
Thanks,
Steven
If you need something easy to see (say for example if you are commenting
where your remoting handlers are), something like:
///
// Remoting Handlers
///
// other code
///
// Button Handlers
///
Just throwing it out there.
--
dnk
___
Flashcoders@chattyfig.figleaf.com
To change your subscription options or search the archive:
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Brought to you by Fig Leaf Software
Premier Authorized Adobe Consulting and Training
http://www.figleaf.com
http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
Putting a block comment before a function is standard, though (Javadoc).
Putting one *inside* a function is awful, though, I agree.
/**
* This is a perfectly fine Javadoc comment
*
* @param bar some parameter
*/
public function foo(bar:Object):Void {
/* Using a block comment here is totally bogus. */
// Line comments, though, are great!
}
-Original Message-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] On Behalf Of Steven
Sacks | BLITZ
Sent: Wednesday, August 23, 2006 10:21 AM
To: Flashcoders mailing list
Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions
I have an issue with coders who put block comments in the middle of
their code, such as:
/***
** SOME COMMENTS
**/
function foo() {
trace(hello world);
}
Or even worse:
/***
** SOME COMMENTS
**/
function foo() {
/* some comments inside the code */
trace(hello world);
}
People who comment like that are my bane and here is why. Commenting
like that in your code makes it completely impossible to easily and
completely comment out blocks of code using /* */ because they have
their */ inside their comments. Believe it or not, this is a very
important tool in debugging.
So, please do everyone a favor and only use block comments before and
after your code and use line comments // for all comments inside your
code. :)
Thanks,
Steven
___
Flashcoders@chattyfig.figleaf.com
To change your subscription options or search the archive:
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Brought to you by Fig Leaf Software
Premier Authorized Adobe Consulting and Training
http://www.figleaf.com
http://training.figleaf.com
___
Flashcoders@chattyfig.figleaf.com
To change your subscription options or search the archive:
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Brought to you by Fig Leaf Software
Premier Authorized Adobe Consulting and Training
http://www.figleaf.com
http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
Putting a block comment before a function is standard All standards are is somebody's way of saying I code like this and so should you. Everyone codes how they want to anyway. And by the way, nobody reads those documents anyway. I certainly don't. I read code the way I read music. I don't need a document to explain to me why the song goes C#, E, B# when I can just look at the tablature. // // This is much better commenting // It's easier to read than all those asterisks // IMNSHO / ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
-Original Message- From: [EMAIL PROTECTED] [mailto:flashcoders- [EMAIL PROTECTED] On Behalf Of Steven Sacks | BLITZ Sent: Wednesday, August 23, 2006 11:19 AM To: Flashcoders mailing list Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions Putting a block comment before a function is standard All standards are is somebody's way of saying I code like this and so should you. Fair enough; it is *a* standard. But it is widely used, informative, and, perhaps most importantly, there is software out there that can automatically generate documentation from it. And by the way, nobody reads those documents anyway. I do. It's far easier to read one sentence of English than scan ten lines of cryptic code. // // This is much better commenting // It's easier to read than all those asterisks // IMNSHO / Oh I used about 6 asterisks in my example. I don't like huge lines of them, either. -- Mike Keesey ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
Commenting in such a way that a document generator can parse your code is a good thing. I use VisDoc on OSX and it save a great deal of time. On Aug 23, 2006, at 2:45 PM, Mike Keesey wrote: -Original Message- From: [EMAIL PROTECTED] [mailto:flashcoders- [EMAIL PROTECTED] On Behalf Of Steven Sacks | BLITZ Sent: Wednesday, August 23, 2006 11:19 AM To: Flashcoders mailing list Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions Putting a block comment before a function is standard All standards are is somebody's way of saying I code like this and so should you. Fair enough; it is *a* standard. But it is widely used, informative, and, perhaps most importantly, there is software out there that can automatically generate documentation from it. And by the way, nobody reads those documents anyway. I do. It's far easier to read one sentence of English than scan ten lines of cryptic code. // // This is much better commenting // It's easier to read than all those asterisks // IMNSHO / Oh I used about 6 asterisks in my example. I don't like huge lines of them, either. -- Mike Keesey ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
I have to add that yes I do read comments left by others in their code... It helps me understand their code... ...it also helps me say What the F*** were they thinking!? -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Behalf Of Ian Thomas Sent: Wednesday, August 23, 2006 4:19 PM To: Flashcoders mailing list Subject: Re: [Flashcoders] Flash/Actionscript Coding conventions On 8/23/06, Steven Sacks | BLITZ [EMAIL PROTECTED] wrote: All standards are is somebody's way of saying I code like this and so should you. Everyone codes how they want to anyway. Do you work in teams a lot, just out of interest? Do you have to alter/update/read other team members code a lot? Standards help. I don't care what the standards _are_, as long as the people on the team agree a standard between themselves it really does lighten the workload. And by the way, nobody reads those documents anyway. Yes they do. People who are writing code to an API that you've created read those documents. Particularly if they don't actually have your source code; they're using a plugin (or accessing an object via an interface and don't have the implementation). Less skilled coders using complex code read those documents. Experienced coders who don't want to take the time to trawl through possibly impenetrable code read those documents. Ian ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: RE: [Flashcoders] Flash/Actionscript Coding conventions
On 8/23/06, Steven Sacks | BLITZ [EMAIL PROTECTED] wrote: Putting a block comment before a function is standard All standards are is somebody's way of saying I code like this and so should you. Everyone codes how they want to anyway. And by the way, nobody reads those documents anyway. I certainly don't. I read code the way I read music. I don't need a document to explain to me why the song goes C#, E, B# when I can just look at the tablature. /* LOL What the hell is a B# anyway? I suppose that you could think of B# as a C, but why would you make it confusing for yourself? This is a great example of a bad notation standard in music. I tend to not like it when people write on beat staccato eighth notes with a rest right after them instead of a dot on top of a quarter note, but I digress, and this is way OT now. ;-) */ -Chris ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
Experienced coders who don't want to take the time to trawl through possibly impenetrable code read those documents. If you write impenetrable code, you need to reevaluate your career choice. If you're not willing to put forth the effort to be great at what you do, especially in something as sensitive as programming, then do something else for a living. No amount of documentation can make up for bad code, and a bad coder isn't going to write good documentation anyway! ;) And to the point about Javadoc, I'm not going to ruin my code and handicap my debugging ability to satisfy some poorly thought out requirement of a 3rd party tool. They require you to use block commenting in your code to automatically write documentation and that's counterproductive to actual coding. It should work hand in hand with not diametrically opposed to the coding process. If they were smart about it, they would support line commenting with non-asterisk delimiters. Say //! !//, or //| |// or //[ ]//, etc. Exclamations, pipes, and brackets are all better choices because they do not conflict with anything. I'm not going to make my process suffer nor am I going to litter my code with ugly asterisks just to document my work when I can spend that energy writing cleaner, easier to read code with light commenting in the code itself. :) ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
Your code could be difficult to read for other developers for a variety of reasons.. often readability is lessened in the name of optimization.. or you could simply be doing something that is very complex.. why does adding block comments to your code ruin it? On Aug 23, 2006, at 5:03 PM, Steven Sacks | BLITZ wrote: Experienced coders who don't want to take the time to trawl through possibly impenetrable code read those documents. If you write impenetrable code, you need to reevaluate your career choice. If you're not willing to put forth the effort to be great at what you do, especially in something as sensitive as programming, then do something else for a living. No amount of documentation can make up for bad code, and a bad coder isn't going to write good documentation anyway! ;) And to the point about Javadoc, I'm not going to ruin my code and handicap my debugging ability to satisfy some poorly thought out requirement of a 3rd party tool. They require you to use block commenting in your code to automatically write documentation and that's counterproductive to actual coding. It should work hand in hand with not diametrically opposed to the coding process. If they were smart about it, they would support line commenting with non-asterisk delimiters. Say //! !//, or //| |// or //[ ]//, etc. Exclamations, pipes, and brackets are all better choices because they do not conflict with anything. I'm not going to make my process suffer nor am I going to litter my code with ugly asterisks just to document my work when I can spend that energy writing cleaner, easier to read code with light commenting in the code itself. :) ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
If you're using eclipse, just use Ctrl+7 to comment a block out using double slashes. Doing it again removes them. This feature works in FDT and JDT. CDT uses Ctrl+\ instead I believe. So I do hear what you're saying, but tools can easily get around problems like this. And people do read docs. I do regularly. If you're ever dealing with a complex framework (Swing, Eclipse...or anything really) you have to read the docs to understand what's going on. Especially because in some cases because warnings are made to not override this or that (soft finals). Just look at the .NET framework. The code just isn't available. How else can you understand what's going on? Scott On 23/08/06, Steven Sacks | BLITZ [EMAIL PROTECTED] wrote: Experienced coders who don't want to take the time to trawl through possibly impenetrable code read those documents. If you write impenetrable code, you need to reevaluate your career choice. If you're not willing to put forth the effort to be great at what you do, especially in something as sensitive as programming, then do something else for a living. No amount of documentation can make up for bad code, and a bad coder isn't going to write good documentation anyway! ;) And to the point about Javadoc, I'm not going to ruin my code and handicap my debugging ability to satisfy some poorly thought out requirement of a 3rd party tool. They require you to use block commenting in your code to automatically write documentation and that's counterproductive to actual coding. It should work hand in hand with not diametrically opposed to the coding process. If they were smart about it, they would support line commenting with non-asterisk delimiters. Say //! !//, or //| |// or //[ ]//, etc. Exclamations, pipes, and brackets are all better choices because they do not conflict with anything. I'm not going to make my process suffer nor am I going to litter my code with ugly asterisks just to document my work when I can spend that energy writing cleaner, easier to read code with light commenting in the code itself. :) ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
On 8/23/06, Steven Sacks | BLITZ [EMAIL PROTECTED] wrote: Experienced coders who don't want to take the time to trawl through possibly impenetrable code read those documents. If you write impenetrable code, you need to reevaluate your career choice. If you're not willing to put forth the effort to be great at what you do, especially in something as sensitive as programming, then do something else for a living. No amount of documentation can make up for bad code, and a bad coder isn't going to write good documentation anyway! ;) I think we'll have to agree to disagree on this one. Your ideal is all very well, but in the real world there _are_ people who write impenetrable code - who optimise when they don't need to, for example. And who, for example, write sprawling functions. It's a d*mn sight easier to read a bit of documentation which says 'returns this in this circumstance, returns the other if it fails' than it is to trawl through the code working out what's going on. I work a great deal with other coders; with teams of coders. From what you say, it sounds like you don't. Ian ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
So you never look at the Flash help code? You just open the .as files and trawl through them? And to the point about Javadoc, I'm not going to ruin my code and handicap my debugging ability to satisfy some poorly thought out requirement of a 3rd party tool. They require you to use block commenting in your code to automatically write documentation and that's counterproductive to actual coding. It should work hand in hand with not diametrically opposed to the coding process. If they were smart about it, they would support line commenting with non-asterisk delimiters. Say //! !//, or //| |// or //[ ]//, etc. Exclamations, pipes, and brackets are all better choices because they do not conflict with anything. I am totally confused by your raging asteriskism. What do asterisks conflict with that those do not? What's wrong with asterisks? I actually like having block comments before functions because it makes it ridiculously easy to comment out a function. Just remove the last / (assuming there's a block comment after the function as well; if not you have to add a */). Makes it very easy to do Move Method refactorings and suchlike. I'm not going to make my process suffer nor am I going to litter my code with ugly asterisks just to document my work when I can spend that energy writing cleaner, easier to read code with light commenting in the code itself. :) I still don't understand how Javadoc makes your process suffer. -- Mike Keesey ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
All standards are is somebody's way of saying I code like this and so should you. No, if implemented by a group, they're the group's way of saying, we code like this and so should you, if you want to be in this group. There's a huge difference between the two. I read code the way I read music. I don't need a document to explain to me why the song goes C#, E, B# when I can just look at the tablature. Why should I want to read through code instead of reading documented method signatures, unless I specifically want to rewrite that code? Tools like Javadoc let you quickly identify the things you need to know - inputs and outputs - and ignore the rest. How the code does what it does is irrelevant if the code is modular as it should be. Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
why does adding block comments to your code ruin it? I still don't understand how Javadoc makes your process suffer. From my first post: Commenting like that in your code makes it completely impossible to easily and completely comment out blocks of code using /* */ because they have their */ inside their comments. Believe it or not, this is a very important tool in debugging. If somebody wrote something completely impenetrable and I'm in charge of implementing it and it doesn't work, guess what? I rewrite it or I make them fix it. I'm not saying documentation isn't important, I'm saying mucking up your code with documentation in Actionscript by using Javadoc's requirements is counterproductive to Flash development. If Javadoc let me use line comments instead of block comments I would have no issue. ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
I find Hungarian Notation to work well in ActionScript 2.0 http://en.wikipedia.org/wiki/Hungarian_notation mcScoreboard txtScore aPlayers sName etc. -mL http://knowledge.lapasa.net -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Behalf Of Bjorn Schultheiss Sent: Monday, August 21, 2006 8:57 PM To: 'Flashcoders mailing list' Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions The best place to find conventions is in the component framework, specifically the new flex framework uses upto date best practices. Otherwise there are AS2 best pratices docs on the adobe site, I think they were written by jen deHann Regards, Bjorn Schultheiss Senior Flash Developer QDC Technologies -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Haikal Saadh Sent: Tuesday, 22 August 2006 10:08 AM To: Flashcoders mailing list Subject: [Flashcoders] Flash/Actionscript Coding conventions Hi all The earliest document I could find about coding conventions for flash and actionscript are from flash 5. Has anyone written up a guide for use AS2/3? I prefer to use my java/javascript conventions as a base, but that still excludes things like: * Naming symbols/linkages * Naming frames (not that I've had a need to, but in case...) * Use of __ and _ in front of variable names. (_ is straight-forward enough, and the v2 comp. architecture seems to use __ for private vars that have corresponding get/set methods. Any other conventions you guys use? -- Haikal Saadh Applications Programmer ICT Resources, TALSS QUT Kelvin Grove ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
that lead me down some interesting paths...I didnt know there were 2 versions... Im still not a fan of that style of Hungarian notation but I can see the benefits of the 'original' : http://www.joelonsoftware.com/articles/Wrong.html you learn something new every day :) Mark Lapasa wrote: I find Hungarian Notation to work well in ActionScript 2.0 http://en.wikipedia.org/wiki/Hungarian_notation ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
Re: [Flashcoders] Flash/Actionscript Coding conventions
Not sure if anyone mentioned this but Simon Wacker wrote a nice article in April 05, ActionScript 2 Coding Standards: The Method. He also offers a pdf at the top of the article. Might be of interest. http://www.simonwacker.com/blog/archives/87.php Dunc On 8/22/06, Martin Wood [EMAIL PROTECTED] wrote: that lead me down some interesting paths...I didnt know there were 2 versions... Im still not a fan of that style of Hungarian notation but I can see the benefits of the 'original' : http://www.joelonsoftware.com/articles/Wrong.html you learn something new every day :) Mark Lapasa wrote: I find Hungarian Notation to work well in ActionScript 2.0 http://en.wikipedia.org/wiki/Hungarian_notation ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
[Flashcoders] Flash/Actionscript Coding conventions
Hi all The earliest document I could find about coding conventions for flash and actionscript are from flash 5. Has anyone written up a guide for use AS2/3? I prefer to use my java/javascript conventions as a base, but that still excludes things like: * Naming symbols/linkages * Naming frames (not that I've had a need to, but in case...) * Use of __ and _ in front of variable names. (_ is straight-forward enough, and the v2 comp. architecture seems to use __ for private vars that have corresponding get/set methods. Any other conventions you guys use? -- Haikal Saadh Applications Programmer ICT Resources, TALSS QUT Kelvin Grove ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
RE: [Flashcoders] Flash/Actionscript Coding conventions
The best place to find conventions is in the component framework, specifically the new flex framework uses upto date best practices. Otherwise there are AS2 best pratices docs on the adobe site, I think they were written by jen deHann Regards, Bjorn Schultheiss Senior Flash Developer QDC Technologies -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Haikal Saadh Sent: Tuesday, 22 August 2006 10:08 AM To: Flashcoders mailing list Subject: [Flashcoders] Flash/Actionscript Coding conventions Hi all The earliest document I could find about coding conventions for flash and actionscript are from flash 5. Has anyone written up a guide for use AS2/3? I prefer to use my java/javascript conventions as a base, but that still excludes things like: * Naming symbols/linkages * Naming frames (not that I've had a need to, but in case...) * Use of __ and _ in front of variable names. (_ is straight-forward enough, and the v2 comp. architecture seems to use __ for private vars that have corresponding get/set methods. Any other conventions you guys use? -- Haikal Saadh Applications Programmer ICT Resources, TALSS QUT Kelvin Grove ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com ___ Flashcoders@chattyfig.figleaf.com To change your subscription options or search the archive: http://chattyfig.figleaf.com/mailman/listinfo/flashcoders Brought to you by Fig Leaf Software Premier Authorized Adobe Consulting and Training http://www.figleaf.com http://training.figleaf.com
