Close Menu
MasstamilanMasstamilan
    Facebook X (Twitter) Instagram
    MasstamilanMasstamilan
    • Home
    • News
    • Business
    • Technology
    • Fashion
    • Entertainment
    • Digital Marketing
    • Social Media
    MasstamilanMasstamilan
    Home»News»Writing code to a style guide transfers that information into the code itself.
    News

    Writing code to a style guide transfers that information into the code itself.

    AlbertBy AlbertMarch 6, 2021Updated:December 22, 2021No Comments2 Mins Read
    Share
    Facebook Twitter LinkedIn Pinterest Email

    You’re able to acclimate quickly, sidestepping the tedious process of relearning what the code does before you can start investigating the real issue. Any good style guide prescribes when and how to leave comments in code. Most developers have an aversion to comments because it seems a lot like writing documentation — and developers tend to hate writing documentation.

    This is usually because writing documentation is seen as time not writing code. However, it’s the documentation that allows you to come back to code you wrote in the past and quickly get back up to speed. Another common argument against using comments is that code should be self-documenting.

    In reality, there is no such thing as self-documenting code. Self-documenting code is a myth perpetuated by people who hate to write documentation. A common argument against writing comments is, “if you can’t understand my code, then you’re not smart enough.” In reality, understanding code has nothing to do with how smart a developer is, but rather providing enough context so the code make sense.

    Read more about:  

    Lastly comment

    Without comments, or a direct discussion with the code author, it’s very hard to get enough context. The best-understood code is littered with comments explaining key sections. You certainly don’t want a comment for every line of code, and comments must provide additional context and information that cannot otherwise be gleaned from reading the code. Here’s an example of a bad comment:

    Visit this site: to download all kinds of latest movies.

    brand guidelines example branding guide template c++ coding style google c++ style guide google coding style logo guidelines why code style is important
    Share. Facebook Twitter Pinterest LinkedIn WhatsApp Reddit Tumblr Email
    Albert
    • Website

    Recent Post

    Modular Revolution: An In-Depth Introduction to Off-Stamp Vapes

    February 25, 2026

    What Is Office Chair Butt and How Can You Avoid It?

    February 25, 2026

    Keyless vs Fingerprint Smart Locks: Which is Best?

    September 15, 2025

    Environmental Impacts of CNC Coolants: How to Reduce Waste?

    February 3, 2025

    Budget-Friendly Ergonomics: Is the Sihoo Doro C300 the Best Value Chair?

    January 21, 2025
    Categories
    • Album
    • Apps
    • Arts and culture
    • Automative
    • Beauty Tips
    • Business
    • Diet
    • Digital Marketing
    • Drawing
    • Education
    • Entertainment
    • Environment
    • Exercise
    • Fashion
    • Financial
    • Fitness
    • Food
    • Games
    • Health
    • Hits Collection
    • Home Improvement
    • Latest Album
    • Law
    • Lifestyle
    • Moving and Storage
    • News
    • Nutrition
    • Pet
    • Photography
    • Real Estate
    • Single
    • Social Media
    • Sports
    • Style
    • Tech
    • Technology
    • Travel
    • Web
    • Web design
    • Contact Us
    • Privacy Policy
    Masstamilanpro.com © 2026, All Rights Reserved

    Type above and press Enter to search. Press Esc to cancel.