Greetings,
I was wondering what is the best way to label/name macros/subs. Is it best to use a short label/name or can the description be added as well? I have a lot of macros to write and wanted to make sure I started out on the right path.
See examples below:
Please Login or Register to view this content.Please Login or Register to view this content.
I think this is one of those things that comes down to personal taste. There will be an upper limit to procedure name length, but if you're getting anywhere near that then it's time to rethink.
I tend to use short but descriptive names, so I'd use "ConsolidateMonthlyData" rather than "CMD" as I'll no doubt forget what the latter stands for.
I find short descriptive names best as if I need to call that sub elsewhere in the project code I can easily tell what I'm calling and why just from the name. This is especially helpful if you're coming back to a piece of code after a long time or when you're handing a project over to someone else to maintain.
If you need more description than is sensible in a sub title then use a few comment lines at the start to explain what the sub is for.
Personal opinion, of course.
BSB
BSB,
Thank you for the suggestion - I was concerned having a longer procedure name may slow down the speed of the macro.
Also, is there a way to determine where the macro is being used? In other words, if for some reason I forget where the code is assigned to, how would I "search" for it?
I agree 100% with BadlySpelledBuoy on how to choose good names, and also that's it's somewhat personal. The same guidance applies to variable names.
I always write code as if someone else will maintain it. If I look at my own code 6 months later, I might as well be somebody else. Do your future self a favor.
The length of the name has absolutely no effect on the speed of the macro.
The only way I know of to find out where a Sub is called is to do a find (CTRL+F), search for the name of the sub and check "Current Project".
You didn't ask, but if you are looking at a place where the sub is called and want to see the code for that sub, highlight the name of the sub in the call, right-click, and select Definition.
BTW the With statement is a powerful tool but if you only have one line of code inside it, it doesn't buy you anything. What you did it not wrong but in this case it doesn't provide any advantage over using a single line:
Please Login or Register to view this content.
Hi !
If you are not in a team, it's just a personal practice …
6StringJazzer,
Thank you for the comment about removing the WithStatement. I will going forward.
As always, I am thankful for the Forum and all your suggestions.
There are currently 1 users browsing this thread. (0 members and 1 guests)
Posting Permissions
LinkBack URL
About LinkBacks
Register To Reply
Bookmarks