Give meaning and explanation with the fewest number of characters in a form that is most accepted by your team or community at large.
-5
votes
0answers
30 views
Conventions regarding naming functions with the prefix “do” [on hold]
Some developers using the prefix 'do' when naming function (e.g. def doFoo).
I was curious to know if this is a holdover from any specific language?, just a natural verb people use to describe ...
-1
votes
1answer
45 views
Naming a recursive association entity [closed]
For my current project, I need to create a database table to store a recursive association. I've done a lot of searching and have read answers on questions, such as Naming convention for associative ...
-1
votes
1answer
76 views
Naming of methods that perform some actions under some condition [closed]
I often write such methods to avoid duplication in code and I give them name such as doSomethingIfSomeCondition().
For example:
public class TaskDownloadFile {
private boolean started;
...
-3
votes
2answers
87 views
How to name a clamp function that only clamps from one side? [closed]
Clamp() is a function that ensures that provided variable is in provided range. You can find such function in .NET, in Unity, and probably anywhere.
While it is useful, I often need to clamp my value ...
0
votes
1answer
150 views
Should I limit my type name suffix vocabulary when using OOP?
My co-workers tend to think that it is better to limit non-domain type suffixes to a small fixed set of OOP-pattern inspired words, e.g.:
*Service
*Repository
*Factory
*Manager
*Provider
I believe ...
2
votes
1answer
278 views
Naming: StartDate or StartDateTime when working with DateTimes [closed]
I am using a lot of DateTimes in my application. Now I usually name it like StartDateTime, EndDateTime, etc, to imply there is also a time involved.
I am getting a bit tired of this (it is tiresome ...
0
votes
1answer
216 views
Naming convention: Final fields (not static)
Today I had a discussion with a co-worker about the naming of final fields in Java classes.
In his opionion final fields should also be considered constants since their values won't change after the ...
0
votes
3answers
257 views
Does the pattern of passing in one object instead of many parameters to a constructor have a name?
If you have a constructor that takes a lot of parameters, like this:
public OrgUnitsHalRepresentation(List<OrgUnitSummaryHalRepresentation> orgUnitSummaryHalRepresentationList,
int count, ...
7
votes
4answers
455 views
“Immutable” interfaces
I am confused about the notion of immutability. Consider the following structure of a simplistic calculator:
Here are the interfaces:
interface IOperationalInterface {
int Sum(int a, int b);
}
...
2
votes
2answers
176 views
Multiple classes with the same name, but different namespaces?
I've run into some code (C# if it matters) that has classes which have the same name, but differ in their namespaces. They all tend to represent the same logical thing, but often are different "views" ...
3
votes
1answer
444 views
Why are there so many CSS properties which are essentially the same?
This answer really made me wonder.
I've written CSS before and (usually) I don't really bother to support browsers other than recent firefox and chrome, but in researching I've noticed that, for the ...
1
vote
1answer
62 views
Several enum classes that declare constants with the same names
I'm working on a Java library for sorts for Magic: the Gathering. Well, without going into a lot of detail, in the game there are five different colors of magic: white, blue, black, red, and green. ...
12
votes
5answers
2k views
Is it a bad practice to give two very different files with the same general purpose the same name?
Is it a bad practice to give two very different files with the same general purpose the same name, separating them into different directories?
<script ...
-1
votes
3answers
146 views
What are the bytes between the MSB and LSB named? [closed]
I've searched around and can't find anything on what the middle bytes of a >16-bit integer are called, if anything. Are there standard names for these bytes?
E.g. the number 0x0D0C0B0A would have:
...
0
votes
2answers
139 views
function naming: plural form of “if not exists” [closed]
This is a question about function naming. I am writing some code that updates the structure of a database according to a specification. Somewhere in this code I have something like this:
void ...
0
votes
2answers
90 views
Should I use check or checked? [closed]
I'm designing a library that binds to html elements on a page. In this particular case the input[type='checkbox'] will be checked if the likeItem property returns true and unchecked if the likeItem ...
2
votes
2answers
268 views
Project based prefix for class names
My project leader uses project based prefixes for class names, lets say projects name ABC, he create User class name as ABCUser. and he says he do this becasuse if he wants to make User.aspx Users get ...
3
votes
3answers
90 views
Is it bad to use the same class or idiom names as in a third-party API that you're using?
FlashPunk is a third-party graphics API for simple game development in AS3, and they take what are effectively sprites or display objects of some sort and refer to them as "Entities". Entity is the ...
4
votes
4answers
253 views
Naming boolean variables: negated or not
A few years ago, I was in a software engineering class and the teacher explained how messages, options, variables, etc. should not be negated to avoid confusion. He gave the example (something like):
...
30
votes
9answers
3k views
How to name a method that both performs a task and returns a boolean as a status?
If there is a method
bool DoStuff() {
try {
// doing stuff...
return true;
}
catch (SomeSpecificException ex) {
return false;
}
}
should it rather be called ...
1
vote
1answer
174 views
Naming in Security Protocols: Alice, Bob and Eve
Among computer scientists and programmers, there's the common habit of naming people in the context of security protocols e.g. Alice, Bob or Eve. Descriptions of more elaborate attack vector sometimes ...
20
votes
2answers
2k views
Should one always know what an API is doing just by looking at the code?
Recently I have been developing my own API and with that invested interest in API design I have been keenly interested how I can improve my API design.
One aspect that has come up a couple times is ...
0
votes
2answers
148 views
c# naming - What are common conventions for a suffix to distinguish between read-only and writable interfaces [closed]
Assume an interface that allows queries on a spatial tree
public ISpatialTree
{
int FindChildIndex(Vector point);
bool IsLeaf { get; }
ICollection<ISpatialTree> Children { get; }
}
...
1
vote
1answer
82 views
Use Generic of Specific Function names for similar objects
Is there a school of thought on putting focus on using generic names for functions, opposed to naming functions based on the things they do?
Example
Say we have a Bill / Price Sheet object, that has ...
4
votes
2answers
248 views
Should duck typing affect naming conventions?
I'm a C++/C# developer and recently I've started to learn Python. I think I understand the concept of duck typing right now except for one thing.
When I'm coding in C++ or C# I sometimes create ...
1
vote
1answer
128 views
How to name filename parameter to make clear it should contain full path? [closed]
I'm seeking vital naming of string filename parameter in parameter list used in various methods where filename with full path is expected. In many cases also UNC path can be actually supplied as full ...
-1
votes
2answers
56 views
Naming convention for classes that represents different versions of the same thing [closed]
Let's imagine I have an abstract class named ProtocolA that represents the basic operations to work with the protocol A. Such protocol is in version 1, but new revisions are expected in the future. ...
-2
votes
3answers
65 views
Method naming advice required [closed]
My question will be about how do you think it would be fit to name some methods in a fluent interface. Let me try to demonstrate the problem.
Consider this relation tree:
A person can have dogs ...
0
votes
1answer
133 views
JSON - Ruby objects key naming
Ruby object has method/property:
def tentakles_count
8
end
JavaScript object has key/property:
{ justEnough: true }
Now, when JavaScript gets serialised ruby object via XHR or WebSocket, ...
1
vote
4answers
136 views
What's in a name? Revision vs Timestamp [closed]
Apparently naming things is one of the hardest things in programming..!
I have a synchronisation implementation which uses timestamps (number of seconds since unix epoch) to sync.
Currently, the ...
2
votes
3answers
160 views
Using past participle for non-altering functions [closed]
I often have naming problems when I write classes and functions. Generally speaking, I try to follow the following set of rules if I have to deal with a function whose name is a verb:
If the ...
-1
votes
3answers
239 views
Should I always use “is” as prefix for boolean variables? [closed]
Should I always use is as prefix for boolean variables? What about booleans that indicate something in past? Should I write isInitialized or wasInitialized? Should I write for properties IsManyMembers ...
4
votes
5answers
265 views
Using π, φ, λ etc. as variable names while programming? [duplicate]
This is a function in the d3.v3.js file (the graph library D3.js):
function d3_geo_areaRingStart() {
var λ00, φ00, λ0, cosφ0, sinφ0;
d3_geo_area.point = function(λ, φ) {
...
0
votes
2answers
87 views
Naming convention for List in xsd schema
What is the best way to name a List in XSD schema?
<xs:element name="CurrentEmployee" type="Employee" minOccurs="0" maxOccurs="unbounded" />
Currently I have a list of Current Employees as ...
5
votes
3answers
646 views
Extension method naming convention [closed]
We are using some utility methods in our company to simplify programming.
So we have following string extension:
public static bool IsNoE(this string s)
{
return string.IsNullOrEmpty(s);
}
...
9
votes
5answers
343 views
How to make it obvious that a function is being accessed from the outside?
This is a C specific question. I am trying to keep everything possible inside the translation unit boundaries, exposing only a few functions through the .h file. That is, I am giving static linkage to ...
5
votes
4answers
355 views
Meaningful names in weakly typed language like JS
I've been learning java for about a year, but recently entered the world of javascript. I'm having trouble coming up with meaningful names in function parameters, so that I'll be able to tell and ...
0
votes
1answer
118 views
Names for generic classes - how to avoid naming them just “object”? Use synonyms?
When programming, I often end up naming some generic class (think of an abstract base class for stuff you manage in your project) something like FooObject, FooComponent or FooItem (where Foo is an ...
1
vote
1answer
152 views
Naming of type parameters in java
We all know that it is good to use descriptive identifier names. However, the convention in java is to use a single letter for a type parameter identifier. The default most people go to is T, but if ...
0
votes
1answer
60 views
Nomenclature for wildcard vs regex expressions [closed]
When I see the term pattern in a description of syntax I infer a regular expression is being specified. Is there a separate term that specifies a wildcard expression?
^foo.*(bar|baz){3} <-- ...
0
votes
2answers
118 views
Naming interfaces for persistent values
I have 2 distinct types of persistent values that I'm having trouble naming well.
They're defined with the following Java-esque structure, borrowing Guava's Optional for the example and using generic ...
0
votes
2answers
626 views
Summary of C# naming conventions (official Microsoft conventions) [duplicate]
I am struggling with naming convetions in C# I do not know when to use PascalCase or camelCase. I have read Microsoft's naming convention, but I got lost ther ...
1
vote
3answers
127 views
How to name arrays or list when the nouns are both singular and plural?
Generally variables are named in the singular Car car; and arrays and list with the pluras: List<Car> cars; or Car[] cars; But what about nouns like fish or media* that are already plural?
...
4
votes
2answers
325 views
Why are “class” variables misspelled? [duplicate]
I have started to see variable initialisations like that in Java libraries:
Class clazz = new Class();
or
Class klass = new Class();
Is there a particular reason for people to misspell the word ...
9
votes
3answers
579 views
How should I mark types in C and C++ programs?
In this answer of mine, I used _t at end of types, which ended at best, controversial. This is the practice I use in my current projects.
typedef struct {
int x;
int y;
} point_t;
This was ...
4
votes
4answers
312 views
Why is the following naming guideline different between OO and non-OO languages?
I am working with a non-OO language and I'm trying to name my routines consistently. I came acrross the following guideline from Steve McConnell's Code Complete:
To name a procedure, use a strong ...
5
votes
1answer
233 views
Should methods that return boolean be named after a question or an assertion? [closed]
Many naming conventions recommend that methods returning a boolean (also called predicate methods) should be named after a question. My question is: don't they really mean the methods should be named ...
2
votes
2answers
207 views
What kind of transform is this?
I have a function that linearly "remaps" a value from a given interval to an other interval?
The function remaps a value from a given interval [oldMin, oldMax] to another interval [newMin, newMax] ...
7
votes
3answers
303 views
What is the name of the functional argument in fold
In the higher order function fold/reduce what is the name, if any, of the functional argument?
I am working on a monadic tabular processing library where rows are folded to produce simple analyses ...
3
votes
2answers
618 views
Semantic CSS class names [closed]
I always read articles that suggest to not use presentational CSS class names. Currently I'm working on a small website project. The footer on this website looks like this:
Although it's pretty ...
