Qqwy

Qqwy

TypeCheck Core Team

Code style: Main functions on top, small functions on bottom or vice-versa?

When programming a module in Elixir, I like to start my module with one or two ‘main’ functions that show the main flow of data that will go on in here, and then write out the ‘small’ functions that are used internally in there.

I find this to be very readable, and giving future readers the opportunity to first see the problem from afar, and then zoom in to the part where you think something might need to be changed or updated.

Now I’ve seen multiple people writing modules in the opposite fashion, with the smallest (often private) functions on top, and the main functions at the bottom. I personally find it less nice to read, but are there any advantages of this approach?

First 2 of 2 Posts Switch mode

NobbZ

NobbZ

I do prefer to have public stuff at the very top of my source files, sorted by importance, after that all the private stuff in random order¹. Organizing the module this way, makes public stuff much more discoverable.

Nevertheless, especially when getting back from a C, C++, Idris, or Agda marathon, I often code in the opposite direction, because all of these languages need to have at least declare before use.

1: Whenever I realize there is a new private necessary I hit PgDn a couple of times, and when my cursor is in the section of private functions, I start to code/hack where I am.

karolsluszniak

karolsluszniak

This is indeed a nice question. Reading through Programming Elixir, I’ve got an impression that each public function should have its private helper functions grouped directly under it. This is certainly made easy by such a compact privacy notation of def and defp.

Still, I didn’t find any info about this neither in the book nor in other articles (such as the style guide). Maybe it’s a delicate matter and no one wants to enforce one way.

I’d also suggest taking a look at source code of serious repos like Elixir, Phoenix or Ecto. I find Elixir sources nicely written and highly readable.

— All posts loaded —

Where Next?

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 91561 914
New
byu
@chrismccord : I just saw the Extract AGENTS.md from Phoenix.new into phx.new generator commit to the phoenix project. My initial shotgu...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
AstonJ
Just a general thread to post chat/news/info relating to AI/ML stuff that may be relevant for Nx now or in the future. Got anything to sh...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
alexslade
Fly’s CEO posted this recently - Turn And Face The Strange · The Fly Blog It says that Fly is going all-in on sprites, which is a worry ...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New
bjorng
We want to introduce a new native datatype to Erlang: native records. Although replacing all tuple records with native records is not our...
New

We're in Beta

About us Mission Statement