Header Templates
Header documentation templates from Dan Glorioso's Header Hero VSCode Extension
Standard
Default file header that is good for almost every project
/***************************************************************
*
* [filename]
*
* Author: [Your Name]
* Date: 12/24/2025
*
* Summary: [Brief description]
*
**************************************************************/Modified File
Good for collaborative projects, like JumboCode
/***************************************************************
*
* [filename]
*
* Created by: [Your Name (+ Partners)]
* Created on: 12/24/2025
* Modified by: [Modifier's Name]
* Modified on: 12/24/2025
*
* Summary: [Brief description]
*
**************************************************************/Assignment
Headers for academic assignments, like in CS 11, 15, 40
/***************************************************************
*
* [filename]
*
* Assignment: [HW #: Assignment Name]
* Author: [Your Name] (UTLN)
* Date: 12/24/2025
*
* Summary: [Brief description]
*
**************************************************************/Academic
Comprehensive header for academic projects
/***************************************************************
*
* [filename]
*
* Course: [Course Name]
* Instructor: [Instructor Name]
* Date: 12/24/2025
* Author: [Your Name]
*
* Project: [Project Title]
* Purpose: [Brief description of how the file fits into the project]
* Description:
* [A brief description of the file contents]
*
**************************************************************/Personal
For personal projects, hobbies, side quests
/***************************************************************
*
* [filename]
*
* Project: [Project Name]
* Created: 12/24/2025
* Author: [Your Name]
*
* Description:
* [A brief description of the file purpose and contents]
*
**************************************************************/Professional
Template with version tracking
/***************************************************************
*
* [filename]
*
* Project Name: [Project Name]
* Module: [Module Name]
* Author: [Your Name]
* Date: 12/24/2025
* Last Update: [Last Update Date]
* Version: 1.0.0
*
* Summary:
* [A brief description of the file purpose and contents]
*
**************************************************************/Open Source
For open source contributions
/***************************************************************
*
* [filename]
*
* Open Source Project: [Project Name]
* Repository URL: [Repository URL]
* Contributor: [Your Name]
* Date: 12/24/2025
*
* Description:
* [A brief description of the file purpose and contents]
*
**************************************************************/Minimal
Clean and simple
/***************************************************************
*
* [filename]
* Author: [Your Name]
* Date: 12/24/2025
*
**************************************************************/Detailed
Comprehensive header- includes change log
/***************************************************************
*
* [filename]
*
* Project Name: [Project Name]
* Module: [Module Name]
* Author: [Your Name]
* Date: 12/24/2025
* Version: 1.0.0
*
* Description:
* [A brief description of the file purpose and contents]
*
* Change Log:
* - [Date]: [Description of changes]
* - [Date]: [Description of changes]
*
**************************************************************/Machine Learning
Useful for ML and data science projects
/***************************************************************
*
* [filename]
*
* ML Project: [Project Name]
* Author: [Your Name]
* Date: 12/24/2025
* Dataset Used: [Dataset Name]
* Algorithm: [Algorithm Name]
*
* Description:
* [A brief description of the file purpose and contents]
*
**************************************************************/Script
For standalone scripts or utilities
/***************************************************************
*
* [filename]
*
* Script Name: [filename]
* Author: [Your Name]
* Date: 12/24/2025
*
* Description:
* [A brief description of what the script does]
*
* Usage:
* [How to run the script]
*
**************************************************************/Test Suite
Good for tracking tests in a test suite
/***************************************************************
*
* [filename]
*
* Test Suite: [Test Suite Name]
* Module: [Module Name]
* Author: [Your Name]
* Date: 12/24/2025
*
* Description:
* [A brief description of the tests in this file]
*
* Test Cases:
* - [Test Case 1]
* - [Test Case 2]
*
**************************************************************/Web Development
For full-stack web development projects
/***************************************************************
*
* [filename]
*
* Project Name: [Project Name]
* Module: [Module Name]
* Author: [Your Name]
* Date: 12/24/2025
* Last Updated: [Last Update Date]
*
* Technologies Used:
* - [Technology 1]
* - [Technology 2]
*
* Description:
* [A brief description of the file purpose and contents]
*
**************************************************************/API/Library
For publishing APIs, SKDs, or libraries
/***************************************************************
*
* [filename]
*
* Library: [Library Name]
* Version: [Version Number]
* Author: [Your Name]
* Date: 12/24/2025
*
* Endpoints: [List key endpoints/functions]
* Parameters: [Key parameters this file handles]
* Returns: [What this file returns/exports]
*
* Example Usage:
* [Brief code example of how to use this file]
*
**************************************************************/