Sections in source code

In this blog post, I’ll briefly explain the idea of having sections in source code. The IDE Visual Studio Code has a related concept: folding regions.

Source code sections  #

In my code, I like to group related constructs – for example:

//========== Core data structures

export class FileFactory {
  //----- Setting up the FileFactory

  addDirectory(dirPath) {}
  addGeneratedFiles(filePaths, generationFunction) {}

  //----- Using the FileFactory

  getReadable(filePath) {}
}

//========== Helper functions

export function writeFileFactoryToDirectory(fileFactory, outputDir) {}

Visual Studio Code: folding regions  #

Visual Studio Code supports folding regions. These are marked as follows:

//#region Core data structures
//#endregion Core data structures

Alas, they only affect folding. There is an issue asking to display regions in the code outline, though.