Add Varied Name with airSlate SignNow

Add varied name

hello and welcome to having coffee where smoke I'm smoked and today we are going to talk about naming naming and software development this is one of the most difficult issues there are right and whenever you try to research naming anywhere you will find this quote by Phil Carlton there are only two hard things and computer science cache invalidation and naming things right so yeah I kinda agree because naming things in software development is more like an art than you know concrete field that you could get right measure and say okay this is a appropriate name and this is not right you need to develop certain methods around naming things you know what - let me close the window because back so today coffee is with this guy his name is po hanok and I brought him from Seattle so say hello nice people from the internet so grab yourself something nice warm to drink like a cup of coffee and let's get started [Music] so let's discuss let's discuss naming and why is it important well there are a couple of reasons you want to have good names they will allow you to read and understand code faster especially when your navigate foreign code so we name things for a reason right to convey meaning if the names weren't important we will just use memory addresses and that would be fine because yeah everybody knows what this address means and that's it unfortunately that's not the case right we need good names to explain what this variable is about what this class is about what this method what this method is about what this class is about right that's that's very important right to have good names so today I'm gonna go deep into the naming cover the basics of naming for beginner software developers but also yeah don't click away just yet but also I'm gonna touch on the advanced topics as well that come later in the naming especially when you already have a job and you are working with a team so maybe your team doesn't have a good method on naming they want to come up with some good ideas this is exactly what this video is about so let's start with basics so if you can use English names by saying if you can I mean if your code isn't already in different language I think it's okay to use non-english language when you have narrow cases that exist only in your country and there is no real good reason to translate it to English maybe that's valid case to use local language but all others when you don't actually need anything that is for example polish spanish french like only in there don't use this language right use english because you never know what kind of software developers are going to join your project don't mix two languages if you can refactor out local language even gradually but do consistent work to refactor out local language if you can use English second thing classes variables packages are all nouns methods such functions are verbs always always try to have it in this sorta way right this is a convention follow it and also classes are always singular always car vehicle and all of that never cars never vehicles you need one thing because you're going to create one object right if you have already plural form how are you going to create multiple objects or of cars right how many cars is that what is the more plural form of already plural thing avoid abbreviations and acronyms don't use shortcuts right don't do this unless these are like very commonly known things like DB or RDS or something like that don't use abbreviations because yeah eventually and you will get new people in your team and they won't know them and every now and then there is an abbreviation and you when you try to expand it it expands to another abbreviation which is how come up with something better name it think about names it will pay off if you actually give enough time to come up with good names it will save a lot of time in the future when the names are actually good meaningful and so on and other thing I want to recommend and that I think everybody should do it is pick a code convention code style as long as you work in team you need to agree on something there are already code styles available online you can just pick one agree on it and follow it one of the good examples that I use myself and I reckon is Google code style so get the package with Google code style you will have xml's for eclipse 4 IntelliJ and so on and so forth and it will allow you to put that in your IDE and it will automatically correct everything just to match this code style why is it better simple everything is consistent across the project use that and that's it never worry again like press format button it will be automatically formatted for you you don't need to worry it just is it your name doesn't follow the code style you will get a squiggly line underlined and you will know oh yeah I made a mistake here so let's just correct it right so go get a cold style I highly recommend it doesn't matter which one has known gadgets as long as it covers all the major use cases that your particular case needs right ubiquitous ubiquitous enough all right so there's this other mistake that I want to caution you about right it it is a commonly seen things among junior software developers and beginners right so don't try to save memory or CPU cycles by using class variables or less functions you don't really save any memory by using the same variable right if you have a max and then you assign stuff to it then you do some calculation and then you assign it back to X and then you do even more calculation assignment again to X don't do it never never do it always come up with new variables if you can come up with new variables what will happen is the compiler will inline your variables it will actually take all of the use cases of the variable and it will try to compact the memory right it will solve this issue for you don't have to worry about like allocating too much memory unless you're working when some like tightly compacted environment which is like embedded computing on chips or something like that don't worry your computer can handle it don't try to optimize there because that's not actually a cop them--is ation so what you'll end up with is having few variables that don't really mean anything they mean everything basically which is the worst kind of variable you can get right and same thing goes to functions compilers are smart enough to inline all of those functions for you and use names that you can pronounce don't use any of these like the like these names are wrong these names are wrong don't use those not at all always use names that you can't pronounce try to say that out loud or even on a stand-up or in the same room yeah don't avoid not avoid not this part not in the names of variables functions everything don't use that find an anthem don't use not because you end up with something like not not deletable right don't do this you don't want this construction to be in a curve because like on the glance you don't know what that means don't do this there is other thing that is basically a facepalm in my dictionary never ever use a gariand notation basically what Hungarian notation is is adding type to the name of the variable so for example if you have a zero terminated string it would be as set as string zero terminated and then the name has like I don't know first name we are way past the times that you need that information IDs where are so complex tools that they will tell you everything on a hover of mouse right you don't need to know the type just by glancing at the name or actually by glancing at the name you should know what type it might be most likely you're using one of the two things in C++ for example either string or c-style strings which is zero terminated string those two nothing else so pick one and use it everywhere right throughout your project and then you don't need this Hungarian notation it makes things ugly unreadable and it's really hard to follow when you have more complex names and also try avoiding prefixes variable is a member of the class you don't need to say Oh M underscore name of the type that's like 2010 or something because if your classes need prefixes they are too big they are too big you have too big scope you need to reduce your classes split them in parts and then you don't need prefixes because basically class will only have what is necessary in there your class may be too big man just split them up how long and how short your names should be right should they be ten characters should they be twenty one hundred how big so rule of thumb is for iterators you can use one letter right you can use i JK something that's that's the common convention it's fine everybody understands that in almost any other case you need longer name it's about all about finding an appropriate length that carries meaning and I would say three is minimum if you need a comment to explain what variable does or the function does the name is too short and at the same time it shouldn't be too long I would recommend to keep function names under 64 characters just for sake of brevity right if if you need a longer name to describe your function most likely your function is too big most likely you need something that you need separate pieces like so after you break this method and three smaller ones for example and then you call them one by one and you're bigger method come up with higher of abstraction on what we are actually doing in there right if there is a shortened name explaining what the method does use it use the shorter one as long as it explains everything including side-effects if your method has side effects that are not obvious put them in the name of the method even if you have to make it much longer right because whoever is using your method most likely want to go into that method just to make sure that it does what it says it does right most likely they will assume that nothing else happens but if you pass an object into that and it gets modified how did that happen why who did that like no never never do that always include that side effects in your method names name should describe single concern so basically one single thing should happen with that variable with that method or anything like that so when you have something like this number of kilometers stored in one variable and then you have this string that says km as kilometers right and you then concatenate that whenever you do that call this new thing something else call it distance label right it's a it's now a label that contains both the unit and contains the the value right so it has a value and the unit so that's the thing that you need to be concerned with remember to name it accordingly avoid helpers handlers managers all of those things that convey no meaning can you tell me what what the sound helper does or the file handler or the compression helper does compress uncompressed does it look into metadata what does it do can you say if your manager for example is rest for invoking different things at different order call it an Orchestrator right it decides when each step of the process should happen I come up with a better name think it think it think it over so sometimes it's valid to have a handler like I don't know file handler what that usually means that you give a file to this handler you pass it somehow and handler knows what to do with this so usually this means that there's known input a file and handler is this thing that knows what to do with this in it right but if you can avoid it like instead of having a file handler have a file store right that's what it does it's a file store it takes a file from the user and stores it that's its job it's simple it's the name in the name so there are some names that are commonly used and I want to recommend them instead of using helpers or handlers or anything like that and I'm just going to call them out and you can figure out for yourself do they convey any meaning for you do they explain what they do good enough and then if they do you can just pick them and use them right so we have like a decorator producer consumer selector Orchestrator grouper collector persister loader streamer right a lot of those already conveyed the meaning that you need if I have a producer mmm most likely this will do something to produce items that perhaps could be taken by consumer Nikki an attack is Nick Janet a kiss forgive me sorry Nick suggests that you should run your names through the ambiguity filter what that means is basically you ask yourself or you ask a friend what does the name mean other and what you think it means basically so could it mean anything else could you be understood and you know in different way that means that the name is wrong you need to get back to the drawing board and come up with a better one right simple all right guys so these are my naming rules that I try to follow that I recommend to everybody and if you have other ones if you have something that you know that is good that other people should use as well leave note down in the comment called a good recommendation you have let us know we want to know what are the rules that you follow and if you don't agree with anything I said also let us know we want to know let's build a community here let's discuss stuff in the comments right if you enjoyed this short video consider subscribing me and Bionic are saying goodbye and we'll see you in the next one Cheers [Music] you