Articles

Clean Code: Comments

Image
I am always surprised that this subject is still debated today. However, this discussion comes up regularly in talks with junior developers or even experienced developers. I show here my practices on comments that I use for more than 10 years on a daily basis. This article presents code examples in Java but the concepts apply to any language. The majority of comments are redundant Why write the same thing twice? When you ask the question this way, the question is quickly answered! However, it is still common to come across code like this: We will notice in the previous example that the comments have no added value compared to the code. From a reading point of view, your eyes have to focus on a lot more text than the same class without comments. We have to scroll constantly to read such classes.  However, what’s the value of these comments? Nothing more than what is already expressed by the code. To convince ourselves, let's read the same class without any comments: Do you miss some...
Enregistrer un commentaire
Lire la suite

Comment or not ?

Image
Should you add comments to your code ? Multiple opinions exist on that topic, but here is the workflow I've adopted in my code !
Enregistrer un commentaire
Lire la suite

Set a correct exception template !

As a developer, you'll face bugs in production. To analyze what happened, you'll rely on logs and well-known stack traces. But, in order to get stack traces in your logs, exceptions in your application should be handled correctly. Sometimes, you just see no stack trace in your logs because of a block like this: Loading .... Obviously, if an exception happens, you won't have any clue in your logs. This kind of code is often generated by your IDE. So, take a few minutes and change your try/catch template to the following : Loading .... Now, if the same exception appears, it will be rethrown in an unchecked exception. If your application is correctly configured, it will be caught somewhere and logged there. Try to convince your colleagues to do the same !
Enregistrer un commentaire
Lire la suite

Where to put curly braces

Code formatting is clearly something personal. Some prefer code without blank lines, others like when the code is grouped in blocks separated with blank lines. I belong in the second team. A common talk with colleagues is where to put curly braces ?
Enregistrer un commentaire
Lire la suite

Easily create your own Eclipse

Image
Eclipse contains hundreds of preferences to set. It takes years to know perfectly what option exists, which value is the best and where is this option. When you work with multiple workspaces it become almost impossible to have all your preferences set in all of them. If you use one workspace but work with other colleagues, everyone has different settings. What if, you could build your own zip of Eclipse with your plugins, your JDKs, all your preferences applied automatically in a new workspace ? In fact, you can do it quite easily. we will describe all the steps in this article.
3 commentaires
Lire la suite

Eclipse.ini file

A common way to optimize Eclipse performances is to customize its eclipse.ini file. Here is the content of mine (for Eclipse Luna) : -startup plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar -showlocation --launcher.library plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20140603-1326 -product org.eclipse.epp.package.jee.product --launcher.defaultAction openFile --launcher.XXMaxPermSize 256M -showsplash org.eclipse.platform --launcher.XXMaxPermSize 256m --launcher.defaultAction openFile --launcher.appendVmargs -vmargs -server -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -XX:+UnlockExperimentalVMOptions -javaagent:lombok.jar -Xbootclasspath/a:lombok.jar -Dosgi.requiredJavaVersion=1.6 -Xms256m -Xmx1024m -Xverify:none If you don't use Lombok, remove the " -javaagent:lombok.jar " line.
Enregistrer un commentaire
Lire la suite

Reminder : Mdadm commands

I'll try to sum up here everyday needed commands with mdadm. Of course, you'll need to replace partitions letters and numbers by yours. Every line is a different command and require root privileges. Install raid manager (mdadm) on Debian based distros (Ubuntu, Linux Mint...)  apt-get install mdadm Create a new raid with all disks presents  mdadm --create /dev/md0 --level=1 --raid-devices=2 /dev/sda1 /dev/sdb1 Create a new raid with only one present (use it to migrate a single drive to a raid : first create the raid with one disk, copy data, complete the raid with the second disk)  mdadm --create /dev/md0 --level=1 --raid-devices=2 missing /dev/sda1   Get a quick overview of raids running on the system   cat /proc/mdstat  Get full details of a raid   mdadm --detail /dev/md0 Assemble an existing raid with all disks presents  mknod /dev/md0 b 9 0  mdadm --assemble /dev/md0 /dev/sda1 /dev/sdb1 Assemble a...
Enregistrer un commentaire
Lire la suite