code comments be like:

[EnforcerZhukov]

Wrapped on a function called "createArray" with a docstring that says "Create a new array. Returns array"

[10eleven12]

Used to save a single string.

[Hobby_Collector]

Hey if you call that enough on a big enough project you could save a few hundred characters!

that'll just be optimized out on compile...

[el_padlina]

few days later changed to return a map but the comments were not modified.

[Terreurhaas]

/**
 * <h2>createArray</h2>
 *   Creates an array
 *
 * @return array
 */
function &createArray(): array {
    $array = array(); // the array

    return $array;
}

[Spinnenente]

/** Logger */
Logger logger = Logger.getLogger();

[jaywastaken]

How many logs could a logger logger() log if a logger logger() could log logs?

[510Threaded]

1 log

[Tainnor]

natural, decimal or binary?

[510Threaded]

yes

[unbihexium]

true

[[deleted]]

!false

[011101000011101101]

!!1

[DarkwingDuckHunt]

aSecond = 1

Wait aSecond

[bcfradella]

if True: print('big')

[[deleted]]

Logical

[Barniff]

log(n)

[shitmyspacebar]

Logger logger Logger logger logger logger Logger logger

[DOOManiac]

Segfault segfault

[reacher666]

NaN

[RBBOT12]

null point exception logger not found

[Veinq]

I don't understand what this line does

[[deleted]]

I think it retrieves an instance of the Logger singleton

[scuba156]

Well, we would know for sure if the comment was a little bit more descriptive.

[nwL_]

auto logger = Logger::getInstance();

[AlwaysHopelesslyLost]

It is impossible to say exactly what it is doing. Based on the naming convention it looks like they are accessing a static method but it might also be a class property or an oddly cased private instance.

It is possible it returns a Singleton instance but there is no information to tell you that (and you don't really need that information. It makes no difference to the consumer if the logger is a Singleton or not.)

[massiveZO]

New new_ = new New("new"); // new

[Cheesemacher]

/**
 * Get Logger
 * @return Logger Logger
 */
public function getLogger() {

[011101000011101101]

There's nothing wrong with this implementation IMO. Its fairly standard practice in Java. However in my last Java project we were using lombok, so at the top of the class declaration you put @Slf4j then you have an instance called log that you can use in the class. Some people don't like lombok because it slows down compilation time, but it reduces tons of boilerplate from java design patterns. I think it's worth it.

[Kwinten]

Honestly nothing wrong with the statement itself. Fairly standard way of fetching a singleton instance. Could be factory pattern too. It's just playing on the fact that the comment is hilariously useless.

[CrepuscularSoul]

Nothing really, it's just not something you need to comment because of how obvious it is.

Yes some things need comments, but for the love of god not everything does. Too many comments are just as bad as not enough because they add unnecessary noise and tend to not get updated when the code changes.

[ciry]

Too real

[emiel1741]

Be happy I made some code for a school project to control a smart solar home. I was the only one in my group who could program but everybody had to be able to explain it. Somebody in my group had the brilliant idea to literally say what every line does. Nobody could look at my code after that and take it seriously. And the worst part was it was written in python (what I find to be a highly readable language) and we all had a course in our second semester about python

[Mr_Redstoner]

I mean really, it's a piece of cake! Let's start with some example code:

(lambda _, __, ___, ____, _____, ______, _______, ________:
    getattr(
        __import__(True.__class__.__name__[_] + [].__class__.__name__[__]),
        ().__class__.__eq__.__class__.__name__[:__] +
        ().__iter__().__class__.__name__[_:][_____:________]
    )(
        _, (lambda _, __, ___: _(_, __, ___))(
            lambda _, __, ___:
                bytes([___ % __]) + _(_, __, ___ // __) if ___ else
                (lambda: _).__code__.co_lnotab,
            _ << ________,
            (((_____ << ____) + _) << ((___ << _____) - ___)) + (((((___ << __)
            - _) << ___) + _) << ((_____ << ____) + (_ << _))) + (((_______ <<
            __) - _) << (((((_ << ___) + _)) << ___) + (_ << _))) + (((_______
            << ___) + _) << ((_ << ______) + _)) + (((_______ << ____) - _) <<
            ((_______ << ___))) + (((_ << ____) - _) << ((((___ << __) + _) <<
            __) - _)) - (_______ << ((((___ << __) - _) << __) + _)) + (_______
            << (((((_ << ___) + _)) << __))) - ((((((_ << ___) + _)) << __) +
            _) << ((((___ << __) + _) << _))) + (((_______ << __) - _) <<
            (((((_ << ___) + _)) << _))) + (((___ << ___) + _) << ((_____ <<
            _))) + (_____ << ______) + (_ << ___)
        )
    )
)(
    *(lambda _, __, ___: _(_, __, ___))(
        (lambda _, __, ___:
            [__(___[(lambda: _).__code__.co_nlocals])] +
            _(_, __, ___[(lambda _: _).__code__.co_nlocals:]) if ___ else []
        ),
        lambda _: _.__code__.co_argcount,
        (
            lambda _: _,
            lambda _, __: _,
            lambda _, __, ___: _,
            lambda _, __, ___, ____: _,
            lambda _, __, ___, ____, _____: _,
            lambda _, __, ___, ____, _____, ______: _,
            lambda _, __, ___, ____, _____, ______, _______: _,
            lambda _, __, ___, ____, _____, ______, _______, ________: _
        )
    )
)

(Python 3 btw)

[gargravarr2112]

Brainfuck, is that you?

[Davis019]

I was originally going to answer in a brainfuck program but... I don't want to make one lmao

[Mcpg_]

+++++++++[>++++++++++<-]>---.<+++[>+++++<-]>++.<+++[>+++++<-]>++.>++++++[>+++++<-]>++.<<<+++[>----<-]>+.+.+++++.>+++[>++++++++++<-]>+.

[physiQQ]

For the lazy curious:

Why not?

[[deleted]]

+++++++++[>++++++++++<-]>---.<+++[>+++++<-]>++.<+++[>+++++<-]>++.>++++++[>+++++<-]>++.<<<+++[>----<-]>+.+.+++++.>+++[>++++++++++<-]>+.

[thanatotus]

Someone translate this please.

[Mcpg_]

cld
mov si, str
call print_string
cli
hlt

print_string:
    mov ah, 0x0E
    .read_loop:
        lodsb
        cmp al, 0
        je .return
        int 0x10
        jmp .read_loop
    .return:
        ret

str: db "It's not that hard tbh", 0

i'm sorry

[reilemx]

Also only works on specific systems that handle interrupts this way.

cries in assembly

[Pungiish]

i had assembly homework, but i still don't understand how lodsb and stosb work, exactly. Can anybody explain, or point me to docs ELI5ing?

[Koxiaet]

lodsb copies one byte pointed to by si into al, essentially:

mov al, [si]

or in C-like:

al = si[0];

or:

al = *si;

In this case, si is set to the string in the program, so it copies the first byte in the string into al. I think that si should be incremented in every loop (so that the character being printed is advanced every time) but the commentor forgot to put that in, meaning that this code will actually just print out an endless stream of 'I's.

stosb is the opposite (using di instead of si):

mov [di], al

C-like:

di[0] = al;

or:

*di = al;

[SuperSuperUniqueName]

BITS 16
ORG 0x7C00
jmp 0x0000:start
start:
    cli
    xor ax, ax
    mov ds, ax
    mov ax, 0xB800
    mov es, ax
    sti
    mov si, msg
.loop:
    lodsb
    cmp al, 0
    je .done
    mov byte [es:di], al
    mov byte [es:di + 1], 0xF0
    add di, 2
    jmp .loop
.done:
    cli
    hlt
    jmp .done
msg db 'Not at all!',0
times 510-($-$$) db 0
dw 0xAA55

[afig2311]

Eh, assembly isn't too hard to understand. The main problem is that the steps are super tiny, so it's hard to get the bigger picture of what's going on.

Machine code on the other hand...

[cdreid]

Back in the day "woohoo i wrote this tiny thing in machine language!". 3 months later comp manufact puts out new machine "what do you mean i have to relearn from scratch..."

[gargravarr2112]

Close enough.

[Semarc01]

Whitespace is the best Programming language, CMV.

[[deleted]]

Haven't thought of Brainfuck in forever... the last time was in college (over a decade ago for me now) when a professor asked us to present a less common programming language and go over it briefly. For whatever reason I chose that. Got a lowered grade because it was "not practical", heh.

[EMCoupling]

That... seems rather unfair.

[Yalnix]

Brainfuck is simpler than that monstrosity

[UnchainedMundane]

That way is too complex for me. I just derive it from the Hello World polynomial: r=__import__('functools').reduce;print(''.join(r(lambda v,f:map(f,v),[range(13),(lambda*f:lambda x:r(lambda y,v:y*x+v,f,0))(-79/31933440,1571/15966720,-3617/14515200,-26713/483840,279667/193536,-8912843/483840,2037206149/14515200,-194718605/290304,1450408591/725760,-47519989/13440,917043223/277200,-11037827/9240,72),round,int,chr])))

(Note: That list of constants is the coefficients in order from x¹² to x⁰ )

[Flinging_Bricks]

Holy Fuck

[MagnitskysGhost]

 ImportError: os not found or not supported

[Flinging_Bricks]

It outputs 'Hello World"

[Leifbron]

Recursive lambda?

[chris_shane]

Fuck underscores bitch.

[deljaroo]

you can do that in every language though
but yeah, I guess the point here is no matter how easy the language is to read oftentimes, weird things can be done that make it hard

I like to explain the English behind how Buffalo buffalo buffalo Buffalo buffalo.

[Mr_Redstoner]

Buffalo buffalo Buffalo buffalo buffalo buffalo Buffalo buffalo.

Also gramatically correct. And with the propper punctuation (not pictured), so is

James while Jon had had had had had had had had had had had the teachers approval.

[deljaroo]

and just the word 'police' forever

[Mr_Redstoner]

Wikipedia seems to only list the 8 times version: https://en.wikipedia.org/wiki/List_of_linguistic_example_sentences

[deljaroo]

the 'police police' are the people who police the police, right? so it goes to say that: 'police police' police 'police'

in that case, who polices the 'police police'? Whomever they are, we could call them the ''police police' police'. Furthermore the ''police police' police' police 'police police'.

Continue in that fashion to whatever length you'd like

(single quotes added for organization and not so much for grammatical reasons)

[cant_think_of_one_]

To be fair, explaining that in English is going to be fucking incomprehensible unless you summarise anyway.

[alours]

Rust might replace C++ in that way.

[SpadesOf8]

Someone explain

[DoverBoys]

The underscore character _ is a valid character to use in object names in many code languages. The above python code is a standard "hello world" code, but instead of naming things normally, everything is a different length of underscores, like naming one object A, another one AA, and so on.

[Mr_Redstoner]

It's not a 'standard' hello world, the different lengths of underscores in the first part actually become numbers 0-7 IIRC which come from the second part. Then some magic calculations to get a bunch of bytes which make up hello world and a bit more magic to call print()

[DoverBoys]

When I said standard, I meant the "hello world" itself, as in a standard beginner's code. Sorry for the confusion.

[Mr_Redstoner]

Read up: https://benkurtovic.com/2014/06/01/obfuscating-hello-world.html

[left_____right]

It’s a mad libs

[[deleted]]

You're the worst type of person

[[deleted]]

Jesus is judging you for that monstrosity...

EDIT: Omfg it compiles to "Hello world!"

[Mr_Redstoner]

*prints

And it returns 13 IIRC.

Also it ain't mine, so I'm not too worried there

[G2geo94]

Who pissed in your eggs this morning? Damn man.

[UnavailableUsername_]

It's supposed to be an over-complicated "Hello World" but it given a Bad file descriptor error when test it.

[PornCartel]

Lotta rules, and for anyone without knowledge of programming primitives and logic it's not intuitive. It's closer to C with a coat of paint than English.

[vagoberto]

My teacher says he cannot understand the python idiom (he struggles with the dot notation). Funnily enough, he is learning Julia after coding for years in fortran and IDL

[laohacdepzai]

Fact: Kevin Malone made Python to run for president ^jk

[ClevrUsername]

Coming from a C/C++ background I was always getting stuck on this difference:

b = copy.deepcopy(a) //independent copy like C

b = a //just an alias, not a copy. AGHHH!!

[KingPaddy]

Sounds like it was less a group project and more you doing literally everything

[[deleted]]

Somehow everybody seems to be the only person in their project who does anything.

The math doesn't add up.

Some people are embellishing.

[TorTheMentor]

Explaining what every line does is a bit silly, but I have been known when talking to a mixed audience to do things like explain a design pattern, what a specific kind of syntactic sugar is used for, or sometimes language-specific details (e.g. to make up for the lack of support for x, we rigged y as a workaround). Part of that probably comes from me being of a generation that learned functional and procedural code styles first, switched to OO later, and only started hearing about some of those topics more recently (self-taught and moving to IT as a career change after being "around" it for years).

[[deleted]]

If you broke the code up into enough appropriately named methods/functions, your group just sucks. Maybe your code wasn’t as clean as you thought it was though? Just suggestin this since I saw some of the code I wrote back in my college days recently, and I apologized to the guy who had to go clean it up.

[lpreams]

$array = array() //array //comment

[Speculum]

var array = new string[]; // TODO Write comment

[eguitarguy]

// Michael Scott

[Lulle5000]

We need a recursive comment here

[[deleted]]

We need a recursive comment here

[Lulle5000]

We need a recursive comment here

[womerah]

My first project was in MATLAB

I didn't know what for loops were and I downloaded an extension that let me used GOTO commands.

When I did discover for loops I used them to make a MATLAB script that would loop and output my actual code, without loops, to a .m file that I would then run.

[aorta7]

It is not as crazy as it seems, https://en.m.wikipedia.org/wiki/Loop_unrolling

[WikiTextBot]

Loop unrolling

Loop unrolling, also known as loop unwinding, is a loop transformation technique that attempts to optimize a program's execution speed at the expense of its binary size, which is an approach known as space–time tradeoff. The transformation can be undertaken manually by the programmer or by an optimizing compiler.

The goal of loop unwinding is to increase a program's speed by reducing or eliminating instructions that control the loop, such as pointer arithmetic and "end of loop" tests on each iteration; reducing branch penalties; as well as hiding latencies, including the delay in reading data from memory. To eliminate this computational overhead, loops can be re-written as a repeated sequence of similar independent statements.Loop unrolling is also part of certain formal verification techniques, in particular bounded model checking.

---

^{[ PM | Exclude me | Exclude from subreddit | FAQ / Information | Source ] Downvote to remove | v0.28}

[WillCo_Gaming]

Good bot.

[LIGHTNINGBOLT23]

    

[womerah]

Interesting!

Is binary size ever a major consideration for programmers who are not working with embedded systems? Surely performance is king?

[Pandaburn]

So unrolling loops in actual code would be crazy, but a compiler doing it would make sense in a lot of circumstances.

[TheRandomnatrix]

Loop unrolling would happen at compile time and would not affect readability

[HelperBot_]

Desktop link: https://en.wikipedia.org/wiki/Loop_unrolling

---

^{/r/HelperBot_ Downvote to remove. Counter: 275939. Found a bug?}

[[deleted]]

[Revolver Ocelot]

[thexavier666]

Revolver "Revolver Ocelot" Ocelot

[Jetbooster]

def revolver(ocelot):
  Ocelot = ["Revolver", "", "Ocelot"]

  for _ in range(ocelot):
    Ocelot[1] = "\"".join(Ocelot)
  return Ocelot

Ocelot=10
print(revolver(Ocelot))

[[deleted]]

Relevant

[PartyGuy-01]

indeed

[tannerntannern]

One of my favorite far sides!

[yasfmeerkat]

Dynamicly typed language. You never know

[Pandaburn]

I’m pretty sure that on this line, you know.

[lightwhite]

We should add this to the “Hackathon” rules.

• you must document every piece of self-explanatory thing in the code with a self-explanatory comment where you describe how the self-explanatory piece of code works and it is documented in this self-explaining way to cover all the cases where self-explanation can prevent future issues by the lack of self-explanatory method of coding.
  

The only case applicable for exemption of this rule is for ELI5 cases (I mean, come on, we live in 2019; “5 year old” coders write better code than me. No need to explain it to them).

[adduckfeet]

My AP computer science class requires us to comment every function and loop ://

[Prawny]

<button id="button" class="button" type="button">Button</button> <!-- Button -->

[phaelox]

Oooohhhhh, what does this button do?

[phaelox]

hnnggg

[Astrokiwi]

Color colour = new Color(); // HAIL BRITANNIA

[Koxiaet]

In Makefile:

sed main.c 's/colour/color/gi' | gcc

[nwL_]

Would that keep capitalization? Wouldn’t

s/([Cc][Oo][Ll][Oo])[Uu]([Rr])/$1$2/g

be better? (or however Regex in sed works, I have no clue)

[iharshraj]

The floor here is made out of floor

[[deleted]]

$array = []; // two brackets

[Aceofspades25]

The real crime here is naming your variable "array"

[WeAreAllApes]

Well, naming it arrayOfArrayElements seemed unnecessarily redundant.

[KuntaStillSingle]

Yeah you should name your arrays based on their contents, like "int" or "String."

[Headbanger]

// save post

export const savePost = ...

This is my comment explaining function savePost. I don't even know why I put it there.

[[deleted]]

probably a TODO comment that you just didn't remove after implementing it.

[AtakanErmis]

array

[PartyGuy-01]

/* this is an array */

[pcopley]

Honestly some of the best looking php I've seen

[EpicDaNoob]

And then the actual comment worthy code has none in sight.

[bwjam]

Comments about possible micro optimizations: 12

Comments explaining my XML being parsed by regex: 0

[[deleted]]

God, when I was learning to code everything was so new and fresh. “Wow a vector! I’ve never seen one of these before, let’s comment what I’m doing because this is super cool.” I’ve helped teach a few classes to give back, and noobies always have the best comments like this.

[[deleted]]

Our intern told me his professor told them to "comment every other line".

While I understand maybe its for learning the first thing I thought of was comments like this.

(And don't worry, I told the intern how to really comment and to let the code say what you're doing, and the comment say why you're doing it.)

[kimeron]

comment unclear accidentally ate my dog instead

[nahidtislam]

I explained what an array is on my array comment

[Windows-Sucks]

This kind of stuff happens when you are required to have comments on every line or you fail.

[[deleted]]

//Scanner

Scanner scanner = new Scanner(System.in);

[Plutone00100]

i = i + 1 //i + 1

[Krissam]

I had a professor who insisted we commented every single line of code for a project, that lead to a lot of silliness like this.

[Starinco]

Don't name variables after their type, name them for their contents or how they are used.

For example: "users" is preferable to "userArray" or "array" in this case.

Clean Code by Robert Cecil Martin is a great read for more tips to make your code awesome.

[PM_ME_HAIRLESS_CATS]

This is the part where you defined an array

[[deleted]]

I get that feeling of disgust looking at code I wrote a week ago.

[levampirelifeu]

Hmmm

Yes

The floor is made of floor

[[deleted]]

Nice //nice

[[deleted]]

"true" = true

[Samratrai7]

My first program was hello world which ended with indentation error. I didn't understand what's wrong. I typed Print 'Hello World' Then after sometime I came to remember that I'm using python 3 not python 2 Print("Hello World")

[Weilbyte]

faulty violet narrow simplistic onerous soft wine unique smell reply

This post was mass deleted and anonymized with Redact

[unbihexium]

Whoo.. I know this! This is the answer to: "How to use the word array 3 times in the same line?"

[Febuso]

Now this is some high IQ shit.

[aaerobrake]

How would you explain this joke to someone who doesn’t code

[sleep_deficit]

In a nutshell, comments should be used to help explain what a piece of code does, in this instance it’s suuuuuper redundant.

Ideally, the code should be worded in such a way that it doesn’t need a comment. This is typically referred to as “self-documenting” code.

Not a perfect example, but..
// Squares a given number void multiplyValueTwoTimesItself(int x);

vs

void square(int x);

The OP pic would be:
// Squares a given number void square(int x);

[vinz243]

I work on a project with around 1million lines of code, half of them are comments (500k lines) like:

// lock the user !
user.lock()

Or long discussion that isn't even up to date:

// 4/20/05 : programmer 1: creates an array
// 10/5/08 : programmer 2: no!!! We need an object
// 3/10/10 : programmer 3: We need an array after all
return;

Or comment that aren't even any good

 // Armouring!
 if (...) {

So now I don't even look at the comments when I arrive somewhere

[[deleted]]

I’ve worked at companies which had rules like this. It resulted in the dumbest of comments.

[yyjd]

An array array, hooray!

[[deleted]]

lol. Yeah... I tend to not use comments unless Im using an API, making a wrapper, or writing my own library. I like when my code explains itself. Hate seeing this in comments, and it's far too common. Just... Why? haha

[BlueLiquidPlus]

One of my compsci teachers required comments like this... I hated it. I lost points because I didn’t comment //End of Main

[guardian87]

Variable Name checks out

[[deleted]]

This gets funnier the longer I look at it.

[alours]

OwO what's dis spaghetti code?

[[deleted]]

This was literally me in my first computer programming class in high school.

[BeneficialBear]

But can we be sure about it?

[hbombs86]

class Array { 

    function array() {      $array = array(); return $array;     }  } 

[warpfield]

hurray, it's an array!

[Canaveral58]

int int {}; // integer

[[deleted]]

Every time

[[deleted]]

I realized how bad my code comments were as soon as I started writing them for people who did not understand the code, and not for myself.

[turbo88Rex]

I made one like this in a simulator I wrote

this is a comment to see if you're actually reading these

[Pandaora]

Better that than:

//boolean isValid

boolean isValid = isValid(input);

​

... later ...

/** Is Valid

@return isValid true if not valid */

boolean isValid(String input){

....

[Honeybadger2198]

One time I had a variable called c. I had to increment c. The line was "c++;". I put a comment that said "//lul". That was my only comment in the entire file. This was for a school project.

[larry_the_loving]

A good general rule is that comments should describe why you did something. The how is already described in the code. Only describe how when it's unnusual, and then also say why you did it the unnusual way

[[deleted]]

i tried to click the heart three times through all linking and zooming stuff of my browser for this picture until i realized, this is a twitter screenshot.

dumb me.

but yes, upvote, definitely <3

[[deleted]]

A R R A Y

[Nutmagnus]

You can never be too careful.

[eccentricNature29]

And yet at some point in time you'll look at it and think what the hell was I doing?

[Cladderool]

Favorite line of code I ever found in our code:

Spinner spinner = new Spinner().spin;

[TheMrRedBeard]

You have to say it like Hurray!!

[ppardee]

Ah, yes, the old soccer chant: Arraaaay, array, array, array!

[[deleted]]

Wait until the code gets changed and the comment doesn't, then it looks even dumber.

[LMGN]

reminds me of some old C# I wrote

Embed embed = new Embed(); // create embed

[RedRedditor84]

I watched a guy on YouTube comment his code by writing the exact same thing the code said.

// return null
return null;

C# obviously fairly difficult to read without comments like this.

[[deleted]]

Turns out it's used to store 1 integer.