Editor with bi-directional traceability of documents and code

Abstract

The application provides a document and code bidirectional tracing editor, comprising: a document management module for processing the creation, opening, saving and closing of document files, a code management module for processing the creation, opening, saving and closing of code files, and a bidirectional tracing module for jumping from a document area to a code area and locating to a code file bound by a code link when a user clicks on the code link. The document and code bidirectional tracing editor provides an efficient way to manage the relationship between documents and codes, greatly improving the work efficiency of developers and reducing the risk of errors, as users can easily track changes between codes and documents. It supports multiple file formats and programming languages, and has wide applicability.

Description

Technical Field

[0001] This invention relates to the field of computer software technology, and in particular to the design and implementation of document and code editors. Background Technology

[0002] Existing code editors typically only provide code editing and management functions, while document editing and management require the use of other software tools. This makes it difficult to maintain the relationship between documents and code, requiring users to spend a significant amount of time and effort to trace the connections between them. Summary of the Invention

[0003] The technical problem this invention aims to solve is: in order to address the difficulty in maintaining the relationship between documents and code in existing code editors, which requires users to spend a lot of time and effort to trace the relationship between documents and code, this invention provides an editor that allows for bidirectional tracing of documents and code to solve the above problems.

[0004] The technical solution adopted by this invention to solve its technical problem is: an editor for bidirectional traceability of documents and code, comprising:

[0005] A user interface, the user interface including a document area for editing a document and a code area for editing code;

[0006] The document management module is used to handle the creation, opening, saving and closing of document files. The document management module is also used to identify document content involving code files in the document area, and to set code links and bind the code links to the corresponding code files.

[0007] The code management module is used to handle the creation, opening, saving and closing of code files. The code management module is also used to identify code segments in the code file that involve document files in the code area, and to set document links and bind the document links to the corresponding document files.

[0008] The two-way tracing module is used to navigate from the document area to the code area when a user clicks a code link, and to locate the code file linked to the code link.

[0009] It is also used to navigate from the code area to the document area when a user clicks a document link, and to locate the document file to which the document link is bound.

[0010] Preferably, a search module is also included for performing global and local searches in code and documentation files based on keywords, syntax, or comments.

[0011] As a preferred option, a syntax highlighting module is also included for syntax highlighting of code files.

[0012] Preferably, an error detection module is also included to detect errors in the code and provide corresponding prompts and suggestions.

[0013] The beneficial effects of this invention are that this bidirectional document and code tracking editor provides an efficient way to manage the relationship between documents and code, greatly improving developer productivity and reducing the risk of errors, as users can easily track changes between code and documentation. It supports multiple file formats and programming languages, making it widely applicable. Attached Figure Description

[0014] The present invention will be further described below with reference to the accompanying drawings and embodiments.

[0015] Figure 1 This is a structural block diagram of an embodiment of an editor for bidirectional traceability of documents and code according to the present invention. Detailed Implementation

[0016] Embodiments of the present invention are described in detail below. Examples of these embodiments are shown in the accompanying drawings, wherein the same or similar reference numerals denote the same or similar elements or elements having the same or similar functions throughout. The embodiments described below with reference to the accompanying drawings are exemplary and are only used to explain the present invention, and should not be construed as limiting the present invention.

[0017] In the description of this invention, it should be understood that the terms "center," "longitudinal," "lateral," "length," "width," "thickness," "upper," "lower," "front," "rear," "left," "right," "vertical," "horizontal," "top," "bottom," "inner," "outer," "axial," "radial," and "circumferential" indicate the orientation or positional relationship based on the orientation or positional relationship shown in the accompanying drawings. They are used only for the convenience of describing this invention and simplifying the description, and are not intended to indicate or imply that the device or element referred to must have a specific orientation, or be constructed and operated in a specific orientation. Therefore, they should not be construed as limitations on this invention.

[0018] Furthermore, the terms "first," "second," etc., are used for descriptive purposes only and should not be construed as indicating or implying relative importance. In the description of this invention, it should be noted that, unless otherwise explicitly specified and limited, the terms "connected" and "linked" should be interpreted broadly. For example, they can refer to a fixed connection, a detachable connection, or an integral connection; they can refer to a mechanical connection or an electrical connection; they can refer to a direct connection or an indirect connection through an intermediate medium. Those skilled in the art can understand the specific meaning of the above terms in this invention based on the specific circumstances. Furthermore, in the description of this invention, unless otherwise stated, "a plurality of" means two or more.

[0019] Any process or method description in the flowchart or otherwise herein can be understood as representing a module, segment, or portion of code comprising one or more executable instructions for implementing a particular logical function or process, and the scope of the preferred embodiments of the invention includes additional implementations in which functions may be performed not in the order shown or discussed, including substantially simultaneously or in reverse order depending on the functions involved, as will be understood by those skilled in the art to which embodiments of the invention pertain.

[0020] like Figure 1 As shown, this invention provides an embodiment of an editor that allows for bidirectional tracking of documents and code, comprising:

[0021] A user interface, the user interface including a document area for editing a document and a code area for editing code;

[0022] The document management module handles the creation, opening, saving, and closing of document files. It also identifies code files within the document area. In this example, special markers are inserted into the document to identify code files; for example, `@code D: / Project / Code.cpp:25~30` indicates that the code in this document corresponds to lines 25 to 30 of the file `D: / Project / Code.cpp`. Furthermore, code links are set, binding these links to the corresponding code files. The editor parses the special markers and comments in the code or document files and displays the content corresponding to the special markers in the editor.

[0023] The code management module handles the creation, opening, saving, and closing of code files. It also identifies code snippets within the code area that relate to documentation files. Similarly, documentation can be identified through special comments in the code, such as: / / @document

[0024] D: / Design.docx:1.2.1 indicates that the code here corresponds to section 1.2.1 of D: / Design.doc. Since adding special comments in the code increases the line count, the special markers in the document also need to change accordingly. Therefore, the editor listens for changes in the code file's content and updates the document with the line count changes. Furthermore, a document link is set, binding the document link to the corresponding document file. The editor parses the special markers and comments in the code or document file and displays the content corresponding to the special markers in the editor.

[0025] The bidirectional tracking module allows users to navigate from the document area to the code area when they click on a code link, and locate the code file linked to that link. A special marker indicates the file path, line number, or section of the document or code; the editor can then open it directly after parsing. The bidirectional tracking module also allows users to navigate from the code area to the document area when they click on a document link, and locate the document file linked to that document link.

[0026] The search module is used to perform global and local searches in code and documentation files based on keywords, syntax, or comments.

[0027] The syntax highlighting module is used to highlight the syntax of code files.

[0028] The error detection module is used to detect errors in the code and provide corresponding prompts and suggestions.

[0029] This invention uses special markers to record the correspondence between documents and code, and manages and views them through the editor of this invention. File formats or programming language files are still processed by their respective native software. However, this invention allows you to set the software used to process the documents; for example, doc files can be set to open with Word or WPS, and cpp files can be set to open with Notepad++ or Visual Studio Code.

[0030] In the description of this specification, references to terms such as "one embodiment," "some embodiments," "example," "specific example," or "some examples," etc., indicate that a specific feature, structure, material, or characteristic described in connection with that embodiment or example is included in at least one embodiment or example of the invention. In this specification, illustrative expressions of the terms do not necessarily refer to the same embodiment or example. Furthermore, the specific features, structures, materials, or characteristics described may be combined in any suitable manner in one or more embodiments or examples.

[0031] Based on the above-described preferred embodiments of the present invention, and through the foregoing description, those skilled in the art can make various changes and modifications without departing from the inventive concept. The technical scope of this invention is not limited to the contents of the specification, but must be determined according to the scope of the claims.

Claims

1. A document and code bi-directional traceable editor, characterized by, Comprising: a user interface including a document area for editing documents and a code area for editing codes; a document management module for handling creation, opening, saving and closing of document files, and for identifying document contents in a document file referring to code files in the code area and setting code links to be bound with corresponding code files; a code management module for handling creation, opening, saving and closing of code files, and for identifying code snippets in a code file referring to document files in the document area and setting document links to be bound with corresponding document files; a bidirectional trace module for when a user clicks a code link to jump from the document area to the code area and locate to the code file bound with the code link, and for when a user clicks a document link to jump from the code area to the document area and locate to the document file bound with the document link.

2. The editor of claim 1, wherein, a search module for global and local search in code files and document files based on keywords, syntax or comments.

3. The editor of claim 2, wherein, a syntax highlighting module for syntax highlighting of code files.

4. The editor of claim 3, wherein, an error detection module for detecting errors in codes and giving corresponding hints and suggestions.

Images