开发者

How do I name a variable with acronym?

开发者 https://www.devze.com 2022-12-31 03:17 出处:网络
开发者_如何学编程For example in Java for Data Transfer Object I use as: ExampleDTO exampleDTO = new ExampleDTO();
开发者_如何学编程

For example in Java for Data Transfer Object I use as:

ExampleDTO exampleDTO = new ExampleDTO();

So, if I am following PEP 8 (lower_case_with_underscores), what naming convention should I use for similar in Python?


The style most agreeing with PEP-8 would probably be...

example_dto = ExampleDTO()


You may want to look at Python Style Guide

I personally use camelCase for variables and _ (underscore) separated in method names.


Why use acronyms in the first place? I try to avoid them when possible. They obfuscate the code and tend to create code that is hard to browse for quick read. Worst case they bring bugs because of misinterpretation (RndCmp was a Random Compare not a Rounded Complex).

What is DTO? Will it still be used in 2 years? Will every new guy immediately know what it means? In 5 years from now too? Can it be confused with anything else? (Deterministic and Transferable Object?)

The only true (and honest) reason for using acronyms is pure coder laziness. My fun in meetings is to ask about acronyms in variable names and 80% of the times nobody really knows. Even the old guys forget what it meant a couple of years back. We even have some with more than one meanings.

With today great IDE (??) with auto-complete of variable names, laziness is a very bad reason to keep them around. By experience you cannot prevent them, but they should always be questioned.

0

精彩评论

暂无评论...
验证码 换一张
取 消