feat: add new syntax entity - comment doc

src/modules/block.rs

@@ -40,7 +40,7 @@ impl SyntaxModule<ParserMetadata> for Block {
                 continue;
             }
             // Handle comments
-            if token.word.starts_with("//") {
+            if token.word.starts_with("//") && !token.word.starts_with("///") {
                 meta.increment_index();
                 continue
             }
@@ -82,4 +82,4 @@ impl TranslateModule for Block {
         std::mem::swap(&mut meta.stmt_queue, &mut new_queue);
         result
     }
-}
+}

src/modules/statement/comment_doc.rs

@@ -0,0 +1,68 @@
+use heraclitus_compiler::prelude::*;
+use itertools::Itertools;
+use crate::utils::metadata::ParserMetadata;
+use crate::translate::module::TranslateModule;
+
+#[derive(Debug, Clone)]
+pub struct CommentDoc {
+    value: String
+}
+
+impl SyntaxModule<ParserMetadata> for CommentDoc {
+    syntax_name!("Parenthesis");
+
+    fn new() -> Self {
+        CommentDoc {
+            value: String::new()
+        }
+    }
+
+    fn parse(&mut self, meta: &mut ParserMetadata) -> SyntaxResult {
+        match meta.get_current_token() {
+            Some(token) => {
+                let mut col = token.pos.0;
+                if token.word.starts_with("///") {
+                    self.value = token.word[3..].trim().to_string();
+                    meta.increment_index();
+                    while let Some(token) = meta.get_current_token() {
+                        let is_token_underneeth = token.pos.0 == col + 1;
+                        let last_char = self.value.chars().last().unwrap_or_else(|| '\n');
+                        // If the token is a newline, we add a newline to the comment
+                        if token.word.starts_with("\n") {
+                            self.value.push_str("\n");
+                            meta.increment_index();
+                            continue;
+                        }
+                        if token.word.starts_with("///") && is_token_underneeth {
+                            // Update the column of the last comment
+                            col = token.pos.0;
+                            meta.increment_index();
+                            // If the comment signifies a paragrah break, we add two newlines
+                            if token.word[3..].trim().len() == 0 {
+                                if last_char == '\n' {
+                                    continue;
+                                }
+                                self.value.push_str("\n\n");
+                                continue;
+                            }
+                            let delimiter = if last_char == '\n' { "" } else { " " };
+                            self.value.push_str(&format!("{}{}", delimiter, token.word[3..].trim()));
+                        } else {
+                            break;
+                        }
+                    }
+                    Ok(())
+                } else {
+                    return Err(Failure::Quiet(PositionInfo::from_token(meta, meta.get_current_token())))
+                }
+            }
+            None => return Err(Failure::Quiet(PositionInfo::from_token(meta, meta.get_current_token())))
+        }
+    }
+}
+
+impl TranslateModule for CommentDoc {
+    fn translate(&self, _meta: &mut crate::utils::TranslateMetadata) -> String {
+        format!("# {}", self.value.trim().split('\n').join("\n# "))
+    }
+}

src/modules/statement/mod.rs

@@ -1 +1,2 @@
-pub mod stmt;
+pub mod stmt;
+pub mod comment_doc;

src/modules/statement/stmt.rs

@@ -34,13 +34,10 @@ use crate::modules::function::{
     ret::Return,
     fail::Fail
 };
-use crate::modules::imports::{
-    import::Import
-};
+use crate::modules::imports::import::Import;
 use crate::modules::main::Main;
-use crate::modules::builtin::{
-    echo::Echo
-};
+use crate::modules::builtin::echo::Echo;
+use super::comment_doc::CommentDoc;
 
 #[derive(Debug, Clone)]
 pub enum StatementType {
@@ -65,7 +62,8 @@ pub enum StatementType {
     Import(Import),
     Main(Main),
     Echo(Echo),
-    CommandModifier(CommandModifier)
+    CommandModifier(CommandModifier),
+    CommentDoc(CommentDoc)
 }
 
 #[derive(Debug, Clone)]
@@ -90,7 +88,9 @@ impl Statement {
         ShorthandMul, ShorthandDiv,
         ShorthandModulo,
         // Command
-        CommandModifier, CommandStatement, Echo, 
+        CommandModifier, CommandStatement, Echo,
+        // Comment doc
+        CommentDoc,
         // Expression
         Expr
     ]);
@@ -104,7 +104,7 @@ impl Statement {
         match syntax(meta, &mut module) {
             Ok(()) => {
                 self.value = Some(cb(module));
-                Ok(())    
+                Ok(())
             }
             Err(details) => Err(details)
         }
@@ -126,7 +126,7 @@ impl SyntaxModule<ParserMetadata> for Statement {
         for statement in statements {
             // Handle comments
             if let Some(token) = meta.get_current_token() {
-                if token.word.starts_with("//") {
+                if token.word.starts_with("//") && !token.word.starts_with("///") {
                     meta.increment_index();
                     continue
                 }