Example Project

Introduction

This is example repository for testing git-typo-hunter tool. It contain sample code files in various programming language, each demonstrate different comment style and documentation practice.

Features

• Multiple Programming Languages: Include example code in 13 different programming language
• Comprehensive Comment Styles: Demonstrate various commenting technique including:
  • Single-line comments
  • Multi-line block comments
  • Documentation comments
  • Module/Package level documentation
  • TODO and FIXME annotations
• Consistent Structure: Each file implement simple "Greeter" class/module with similar functionality
• Documentation Examples: Show best practice for code documentation in each language
• Type Safety: Where applicable, include type annotation and interfaces
• Modern Syntax: Use modern language feature and string interpolation

Languages

Here are example of how comments look in different languages:

Go

// Single-line comment
/* Multi-line
   block comment */

Python

# Single-line comment
"""
Multi-line docstring
Documentation comment
"""

Java

// Single-line comment
/* Multi-line
   block comment */
/** JavaDoc
  * documentation comment
  */

C#

// Single-line comment
/* Multi-line
   block comment */
/// XML documentation comment

Ruby

# Single-line comment
=begin
Multi-line
comment block
=end

PHP

// Single-line comment
# Alternative single-line
/* Multi-line
   block comment */
/** PHPDoc comment */

Swift

// Single-line comment
/* Multi-line
   block comment */
/// Documentation comment
// MARK: - Section marker

TypeScript

// Single-line comment
/* Multi-line
   block comment */
/** TSDoc documentation */

Kotlin

// Single-line comment
/* Multi-line
   block comment */
/** KDoc documentation */

Scala

// Single-line comment
/* Multi-line
   block comment */
/** Scaladoc comment */

Dart

// Single-line comment
/* Multi-line
   block comment */
/// Documentation comment

Haskell

-- Single line comment
{- Multi-line
   block comment -}
-- | Documentation comment

Perl

# Single-line comment
=pod
POD documentation
block
=cut