Avoid Jumbled Acronyms for Clarity TL;DR: Treat acronyms like normal words to improve human readability. Problems Reduced readability
Breaking naming style
Words confusion
Harder to pronounce Solutions Treat acronyms as Capitalized words


Use camelCase or snake_case Context Acronyms in uppercase (like JSON, XML, REST) in camel case break the natural reading flow. You may think sendJSONRequestOnHTTPREST is a clear name, but it makes your code harder to read, especially when you string multiple acronyms together. Treating acronyms like normal words in camelCase (sendJsonRequest) keeps your code more readable and easier to understand. Sample Code Wrong class NetworkConnector {
    func validateXMLFile() { /*...*/ }
    func sendJSONRequest() { /*...*/ }
    func parseURLResponse() { /*...*/ }
    func setRESTAPIURL() { /*...*/ }
    func retrieveHTTPStatusCode() { /*...*/ }
    func updateDBConnection() { /*...*/ }
    func configureSSLCertificate() { /*...*/ }
    func setHTMLTemplate() { /*...*/ }
    func generateUUID() { /*...*/ }
    func connectViaFTP() { /*...*/ }
} Right class NetworkConnector {
    func validateXmlFile() { /*...*/ }
    func sendJsonRequest() { /*...*/ }
    func parseUrlResponse() { /*...*/ }
    func setRestApiUrl() { /*...*/ }
    func retrieveHttpStatusCode() { /*...*/ }
    func updateDbConnection() { /*...*/ }
    func configureSslCertificate() { /*...*/ }
    func setHtmlTemplate() { /*...*/ }
    func generateUuid() { /*...*/ }
    func connectViaFtp() { /*...*/ }
} Detection [x]Semi-Automatic It would help if you had a smart thesaurus. To detect this smell, look for methods or variable names with uppercase acronyms that disrupt readability. Code reviewers or linters can also flag camelCase inconsistencies. Tags Code Standards Level [x]Beginner AI Generation Modern AI code generators may produce inconsistent acronym casing. Always review and adjust their output to match your conventions. AI Detection With prompts, AI can fix these naming issues and suggest improvements based on the camelCase style. Try Them! Remember: AI Assistants make lots of mistakes Without Proper Instructions

With Specific Instructions



ChatGPT

ChatGPT



Claude

Claude



Perplexity

Perplexity



Copilot

Copilot



Gemini

Gemini Conclusion Naming conventions are key to readable code. Treat acronyms like normal words, and avoid uppercase blocks to keep your code easy to understand. Relations https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-x-i7r34uj More Info https://www.linkedin.com/posts/danielmoka_clean-code-tip-name-acronyms-as-normal-words-activity-7251472396438687744-C4kx/?embedable=true Disclaimer Code Smells are my opinion. Credits Photo by Csabi Elter on Unsplash Thank you @Daniel Moka for this tip. Simple can be harder than complex Steve Jobs https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true This article is part of the CodeSmell Series. How to Find the Stinky Parts of your Code Avoid Jumbled Acronyms for Clarity Avoid Jumbled Acronyms for Clarity TL;DR: Treat acronyms like normal words to improve human readability. TL;DR: Treat acronyms like normal words to improve human readability. Problems Reduced readability Breaking naming style Words confusion Harder to pronounce Reduced readability Breaking naming style Words confusion Harder to pronounce Solutions Treat acronyms as Capitalized words Use camelCase or snake_case Treat acronyms as Capitalized words Treat acronyms as Capitalized words Capitalized Use camelCase or snake_case Use camelCase or snake_case camelCase camelCase snake_case snake_case Context Acronyms in uppercase (like JSON, XML, REST ) in camel case break the natural reading flow. JSON, XML, REST camel case You may think sendJSONRequestOnHTTPREST is a clear name, but it makes your code harder to read, especially when you string multiple acronyms together. sendJSONRequestOnHTTPREST Treating acronyms like normal words in camelCase ( sendJsonRequest ) keeps your code more readable and easier to understand. sendJsonRequest Sample Code Wrong class NetworkConnector {
    func validateXMLFile() { /*...*/ }
    func sendJSONRequest() { /*...*/ }
    func parseURLResponse() { /*...*/ }
    func setRESTAPIURL() { /*...*/ }
    func retrieveHTTPStatusCode() { /*...*/ }
    func updateDBConnection() { /*...*/ }
    func configureSSLCertificate() { /*...*/ }
    func setHTMLTemplate() { /*...*/ }
    func generateUUID() { /*...*/ }
    func connectViaFTP() { /*...*/ }
} class NetworkConnector {
    func validateXMLFile() { /*...*/ }
    func sendJSONRequest() { /*...*/ }
    func parseURLResponse() { /*...*/ }
    func setRESTAPIURL() { /*...*/ }
    func retrieveHTTPStatusCode() { /*...*/ }
    func updateDBConnection() { /*...*/ }
    func configureSSLCertificate() { /*...*/ }
    func setHTMLTemplate() { /*...*/ }
    func generateUUID() { /*...*/ }
    func connectViaFTP() { /*...*/ }
} Right class NetworkConnector {
    func validateXmlFile() { /*...*/ }
    func sendJsonRequest() { /*...*/ }
    func parseUrlResponse() { /*...*/ }
    func setRestApiUrl() { /*...*/ }
    func retrieveHttpStatusCode() { /*...*/ }
    func updateDbConnection() { /*...*/ }
    func configureSslCertificate() { /*...*/ }
    func setHtmlTemplate() { /*...*/ }
    func generateUuid() { /*...*/ }
    func connectViaFtp() { /*...*/ }
} class NetworkConnector {
    func validateXmlFile() { /*...*/ }
    func sendJsonRequest() { /*...*/ }
    func parseUrlResponse() { /*...*/ }
    func setRestApiUrl() { /*...*/ }
    func retrieveHttpStatusCode() { /*...*/ }
    func updateDbConnection() { /*...*/ }
    func configureSslCertificate() { /*...*/ }
    func setHtmlTemplate() { /*...*/ }
    func generateUuid() { /*...*/ }
    func connectViaFtp() { /*...*/ }
} Detection [x]Semi-Automatic [x] Semi-Automatic [x] It would help if you had a smart thesaurus. To detect this smell, look for methods or variable names with uppercase acronyms that disrupt readability. Code reviewers or linters can also flag camelCase inconsistencies. Tags Code Standards Code Standards Level [x]Beginner [x] Beginner [x] AI Generation Modern AI code generators may produce inconsistent acronym casing. Always review and adjust their output to match your conventions. AI Detection With prompts, AI can fix these naming issues and suggest improvements based on the camelCase style. camelCase camelCase Try Them! Remember: AI Assistants make lots of mistakes Remember: AI Assistants make lots of mistakes Without Proper Instructions

With Specific Instructions



ChatGPT

ChatGPT



Claude

Claude



Perplexity

Perplexity



Copilot

Copilot



Gemini

Gemini Without Proper Instructions

With Specific Instructions ChatGPT

ChatGPT Claude

Claude Perplexity

Perplexity Copilot

Copilot Gemini

Gemini Without Proper Instructions With Specific Instructions Without Proper Instructions Without Proper Instructions With Specific Instructions With Specific Instructions ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT ChatGPT Claude Claude Claude Claude Claude Claude Claude Claude Perplexity Perplexity Perplexity Perplexity Perplexity Perplexity Perplexity Perplexity Copilot Copilot Copilot Copilot Copilot Copilot Copilot Copilot Gemini Gemini Gemini Gemini Gemini Gemini Gemini Gemini Conclusion Naming conventions are key to readable code. Treat acronyms like normal words, and avoid uppercase blocks to keep your code easy to understand. Relations https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxii https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-x-i7r34uj https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-x-i7r34uj More Info https://www.linkedin.com/posts/danielmoka_clean-code-tip-name-acronyms-as-normal-words-activity-7251472396438687744-C4kx/?embedable=true https://www.linkedin.com/posts/danielmoka_clean-code-tip-name-acronyms-as-normal-words-activity-7251472396438687744-C4kx/?embedable=true Disclaimer Code Smells are my opinion . opinion Credits Photo by Csabi Elter on Unsplash Csabi Elter Unsplash Thank you @Daniel Moka for this tip. Simple can be harder than complex Simple can be harder than complex Steve Jobs Steve Jobs https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true https://hackernoon.com/400-thought-provoking-software-engineering-quotes?embedable=true This article is part of the CodeSmell Series. How to Find the Stinky Parts of your Code How to Find the Stinky Parts of your Code

Refactoring 018 - How to Replace a Singleton

Code Smell 276 - Untested Regular Expressions

Buy My Book

Code Smell 277 - UPPERCASE Acronyms

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

10 Predictions About the Future of Finance

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

10 Predictions About the Future of Finance

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps