Commenting your code well is very important for maintenance of your code. In software field it is very common for developers to change jobs very often. So it is very important to keep the code maintainable and understandable with good comments.
Things to Notice
Primary intent of comments is to make your code self documenting
At a minimum add class and method level comments explaining what is the purpose of the class/method. Additional comments should be added on places where explanation/clarification is required.
Don't overdo it
We can see people adding comments every line or every other line. That is also unnecessary. It just makes reading through code more time consuming. Please keep in mind, intent of comment is to make somebody understand what is going on in code. Add granular details only if you feel an average developer might need comments to understand the logic.
Samples
You can use below sample templates as class and method level comments,
Class level comment Method level comment These examples follow ApexDoc syntax requirements. ApexDoc is a java application that is used to generate code documentation from code comments. It follows Javadoc style. If you are following the ApexDoc comment pattern, you will be able to generate static HTML documentation from the code by following instructions in ApexDoc documentation. You can find ApexDoc source and instructions in the repo - https://github.com/SalesforceFoundation/ApexDoc
Are you looking for online tuition in Chandigarh for your child so that your child can complete his/her studies sitting at home without any hassle, then you should take online tutoring from Ziyyara because all the kids studying near Ziyyara always get good marks. Don't delay register today. Call Us For Free Demo:- +91 9654271931. Get Free Demo:- https://ziyyara.in/ad-contact Visit Us:- Online Tuition In Chandigarh
Semenjak adanya Paito Warna Hongkong juga sangat mempermudah para pecinta hk pools mencari prediksi Hongkong hari ini.
Sekarang anda tidak perlu repot untuk mencari bocoran togel hk, sd, sgp. Mengapa demikian? Karena dengan hadirnya situs Prediksi Togel pastinya bisa anda gunakan untuk mencari racikan paito hongkong, singapore, sydney sampai dengan pasaran togel ternama lainnya.
Data HK atau Result Hongkong 4D pastinya sangat dinanti para pecinta TOGEL. Anda bisa dapatkan data hk hari tercepat via situs penyedia Live Draw Hongkong.
Prediksi Togel adalah info yang sangat dibutuhkan para bettor di bandar togel terpercaya untuk mendapatkan referensi angka keluaran togel hari ini terlengkap dan raih kemenangan secara berkala.
Are you looking for online tuition in Chandigarh for your child so that your child can complete his/her studies sitting at home without any hassle, then you should take online tutoring from Ziyyara because all the kids studying near Ziyyara always get good marks. Don't delay register today.
ReplyDeleteCall Us For Free Demo:- +91 9654271931.
Get Free Demo:- https://ziyyara.in/ad-contact
Visit Us:- Online Tuition In Chandigarh
Semenjak adanya Paito Warna Hongkong juga sangat mempermudah para pecinta hk pools mencari prediksi Hongkong hari ini.
ReplyDeleteSekarang anda tidak perlu repot untuk mencari bocoran togel hk, sd, sgp. Mengapa demikian? Karena dengan hadirnya situs Prediksi Togel pastinya bisa anda gunakan untuk mencari racikan paito hongkong, singapore, sydney sampai dengan pasaran togel ternama lainnya.
http://www.lacartes.com/business/ACP-Cloud1-ACP-Cloud-Computing-Certification/1986061
ReplyDeleteData HK atau Result Hongkong 4D pastinya sangat dinanti para pecinta TOGEL. Anda bisa dapatkan data hk hari tercepat via situs penyedia Live Draw Hongkong.
ReplyDeletePrediksi Togel adalah info yang sangat dibutuhkan para bettor di bandar togel terpercaya untuk mendapatkan referensi angka keluaran togel hari ini terlengkap dan raih kemenangan secara berkala.
Thanks for sharing this content.
ReplyDeletehttps://nextlevelgamingstore.net/product/the-art-of-game-development-ebook/
ReplyDeletenice...........!
ReplyDeleteworkday online training
power bi course
mulesoft training