Level Extreme platform
Subscription
Corporate profile
Products & Services
Support
Legal
Français
Naming classes
Message
 
 
To
31/07/2013 16:38:09
General information
Forum:
ASP.NET
Category:
Other
Title:
Environment versions
Environment:
C# 4.0
OS:
Windows 7
Network:
Windows 2003 Server
Database:
MS SQL Server
Application:
Web
Miscellaneous
Thread ID:
01579528
Message ID:
01579607
Views:
52
>>If he is an employee in our company, he will understand.
>
>That's the tricky part. A good percentage of the architecture I do is related to the future and making sure what we do now will be easily understandable by the next one who will take over.
>
>We never know what can happen inside the corporation list of employees and such. I have seen important changes happening in a flash. Then, everyone falls apart because they cannot understand what was done before. Whenever I revise the code of other resources, before approving them, I make sure that I can understand it and that it will be easy for someone new in the team to understand it at any given time. Yes, your thread is important. The naming convention we give to our classes, methods, properties and such is important. Standardization is also related. I am pretty sure you will come up with something that will properly reflect what this method does and can do in the future if it evolves.

Basically, I understand what this class is supposed to do. When this project just started and my colleagues wrote a prototype and implemented a few methods, these methods have messageText and statusCode. These two properties are important as we built our returned string using these two properties.

So, in the initial implementation these two were defined as variables and passed by reference to a few methods. And then all the code started to use the same idea always passing these 2 variables back and forth.

At some point I said - let's change it. It was relatively in the beginning of the project, we had few discussions which didn't lead to anything, so we all kept doing it the same way.

Finally I got fed up and my colleague also suggested a new class. Now a lot of code is already developed so re-factoring will take more time. But I believe it's worth it.

So, this is the class I need - it may evolve in the process. I can describe its functionality in words, but I need a simple name. That was when I started my discussion and it helped me to formulate all of this. But I am still in the dark as how to name this "thing". And while it remains nameless I am not starting coding.
If it's not broken, fix it until it is.


My Blog
Previous
Next
Reply
Map
View

Click here to load this message in the networking platform