multiple comment detected

Author: Zeyue

zeyue/0007/.ComputeCodeLines.py.swp

@@ -1,11 +1,22 @@
-#!/usr/bin/python
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+File: ComputeCodeLines.py
+Author: Zeyue Liang
+Email: [email protected]
+Github: https://github.com/zeyue
+Description:
+    A program that can compute code line numbers in a directory.
+"""
 
 import os
 
 
 file_suffix = "not defined"
 inline_comment_syntax = "not defined"
-multiline_comment_syntax = "not defined"
+start_comment_syntax = "not defined"
+end_comment_syntax = "not defined"
+multilineCommentStartFlag = 0
 result = {"Code files": 0,
           "Total lines": 0,
           "Code lines": 0,
@@ -14,6 +25,12 @@
 
 
 def getFilesList(directory):
+    """Get files's list in a directory
+
+    :directory: files' directory
+    :returns: file path list
+
+    """
     file_paths = []
 
     for root, directories, files in os.walk(directory):
@@ -25,48 +42,90 @@ def getFilesList(directory):
 
 
 def getSuffix(full_file_path):
+    """Get the suffix of current file.
+
+    :full_file_path: path of one file
+    :returns: suffix
+
+    """
     return os.path.splitext(full_file_path)[1][1:]
 
 
 def identifyFileType(suffix):
+    """Identify the file type and return correct syntax.
+
+    :suffix: file suffix
+    :returns: [inline comment syntax, multiple line comment syntax]
+
+    """
     if suffix == "py":
-        return "#", "\"\"\""
+        return "#", "\"\"\"", "\"\"\""
     elif suffix == "c" or suffix == "h" or suffix == "cpp" or suffix == "hpp":
-        return "//", "/*"
+        return "//", "/*", "*/"
+    elif suffix == "java":
+        return "//", "/*", "*/"
     else:
         return "not defined"
 
 
 def isInlineComment(string_line):
-    """This function will check if input line is a comment or not.
+    """Check if string line is an inline comment or not.
 
     :string_line: input line
     :returns: true or false
 
     """
     commentLen = len(inline_comment_syntax)
     if string_line[0:commentLen] == inline_comment_syntax:
+        # print("zero")
         return True
     else:
         return False
 
 
 def isMultilineComment(string_line):
-    commentLen = len(str(multiline_comment_syntax))
-    if string_line[0:commentLen] == multiline_comment_syntax:
+    """Check if the string line is a multiple comment or not.
+
+    :string_line: one string line in the file
+    :returns: True or False
+
+    """
+    global multilineCommentStartFlag
+    commentLen = len(str(start_comment_syntax))
+    # print(multilineCommentStartFlag)
+    if(string_line[0:commentLen] == start_comment_syntax and
+       multilineCommentStartFlag == 0):
+        multilineCommentStartFlag = 1
+        # print("one")
+        return True
+    elif(string_line[0:commentLen] != start_comment_syntax and
+         multilineCommentStartFlag == 1):
+        # print("two")
+        return True
+    elif(string_line[0:commentLen] == end_comment_syntax and
+         multilineCommentStartFlag == 1):
+        multilineCommentStartFlag = 0
+        # print("three")
         return True
     else:
         return False
 
 
 def countOneFile(full_file_path):
-    global inline_comment_syntax, multiline_comment_syntax
+    """Count code lines in one file.
+
+    :full_file_path: full path of the file
+    :returns: null
+
+    """
+    global inline_comment_syntax, start_comment_syntax, end_comment_syntax
+    global multilineCommentStartFlag
     file_suffix = getSuffix(full_file_path)
     if(identifyFileType(file_suffix) != "not defined"):
         result["Code files"] += 1
-
         (inline_comment_syntax,
-         multiline_comment_syntax) = identifyFileType(file_suffix)
+         start_comment_syntax,
+         end_comment_syntax) = identifyFileType(file_suffix)
         with open(full_file_path, "r") as lines:
             for line in lines:
                 line = line.strip()
@@ -77,22 +136,37 @@ def countOneFile(full_file_path):
                     elif isMultilineComment(line):
                         result["Comment lines"] += 1
                     else:
+                        # print("Oops...")
                         result["Code lines"] += 1
                 else:
                     result["Blank lines"] += 1
+        print(str(result))
 
 
 def countInDirectory(directory):
+    """Count code lines in one directory.
+
+    :directory: the directory that will be counted
+    :return: null
+
+    """
     full_file_paths = getFilesList(directory)
     for f in full_file_paths:
         countOneFile(f)
 
-directory = input()
-# countOneFile("d:/NOTBACKEDUP/python/zeyue/0007/ComputeCodeLines.py")
-countInDirectory(directory)
-# countInDirectory("D:/Documents/Zeyue/workspace/Gauge/v1.3.10\
-# /Recorder/QuartzDyne/src")
-# countOneFile("D:/Documents/Zeyue/workspace/Gauge/v1.3.10\
-# /Recorder/QuartzDyne/src/CommandTable.c")
 
-print(str(result))
+def main():
+    """main function.
+
+    """
+    print("Please input a full directory: ")
+    # directory = input()
+    directory = "d:\PythonProjects\python\zeyue"
+    countInDirectory(directory)
+    for key in result:
+        print(str(key) + ": " + str(result[key]))
+
+
+main()
+# if(isMultilineComment("\"\"\"dfadf")):
+# print("yes")