CN103324513A - Program annotation method and device - Google Patents

Abstract

The invention provides a program annotation method and device. The program annotation method comprises the steps of obtaining a multimedia annotation file corresponding to a program code and establishing association relation of the multimedia annotation file and the program code. The program code is annotated by adopting the multimedia annotation file, so that a program maintenance worker can quickly understand the program code according to the multimedia annotation file in the program code, and the maintenance efficiency of the program maintenance worker is improved.

Description

Program annotation method and device

technical field

The invention relates to the field of computers, in particular to a method and device for program annotation.

Background technique

In the prior art, in order to make it easier for program maintenance personnel to understand the program code and maintain it, programmers use text annotations to annotate the program code during the process of writing the program code, but this annotation method is often too simple, and the program maintenance It is difficult for personnel to understand, or there are too many, program maintainers need to spend a lot of time to read, thus reducing the maintenance efficiency of program maintainers.

Contents of the invention

The present invention provides a program annotation method and device, which are used to solve the problem in the prior art that it is difficult to improve the maintenance efficiency of program maintenance personnel by text annotation of program codes.

The first aspect of the present invention provides a method for program annotation, including:

Obtain a multimedia annotation file corresponding to the program code;

An association relationship between the multimedia annotation file and the program code is established.

Another aspect of the present invention is to provide a program annotation device, comprising:

An acquisition module, configured to acquire a multimedia annotation file corresponding to the program code;

The establishment module is used to establish the association relationship between the multimedia annotation file and the program code.

In the present invention, the program code is annotated by using the multimedia annotation file, so that the program maintenance personnel can quickly understand the program code according to the multimedia annotation file corresponding to the program code, and the maintenance efficiency of the program maintenance personnel is improved.

Description of drawings

Fig. 1 is a flowchart of an embodiment of the program annotation method provided by the present invention;

Fig. 2 is a flowchart of another embodiment of the program annotation method provided by the present invention;

Fig. 3 is a flow chart of another embodiment of the program annotation method provided by the present invention;

Fig. 4 is a schematic structural diagram of an embodiment of a program annotation device provided by the present invention.

Detailed ways

In order to make the purpose, technical solutions and advantages of the embodiments of the present invention clearer, the technical solutions in the embodiments of the present invention will be clearly and completely described below in conjunction with the drawings in the embodiments of the present invention. Obviously, the described embodiments It is a part of embodiments of the present invention, but not all embodiments. Based on the embodiments of the present invention, all other embodiments obtained by persons of ordinary skill in the art without making creative efforts belong to the protection scope of the present invention.

Fig. 1 is a flowchart of an embodiment of the program annotation method provided by the present invention, as shown in Fig. 1, including:

101. Acquire a multimedia annotation file corresponding to the program code.

Wherein, the multimedia annotation file may include: the explanation video recorded by the programmer for the program code, the running process and running result of the program code, the running process and running result of the code segment, the writing process of the program code, the background knowledge related to the program code, Or software that enables program maintenance personnel to conduct voice or video connections with programmers. Wherein, the explaining video may include: the explaining content of the programmer and the auxiliary actions or auxiliary equipment used by the programmer during the explaining process.

The multimedia annotation file may use audio, video, animation, static picture, text, compressed package, software, etc. to carry the above content. Wherein, the software can be a specific code, so that the multimedia annotation device can generate audio, video, animation, still pictures, text, etc. that can be played or displayed according to the code.

The program commenting method provided by the invention can be executed by a program commenting device. A specific manifestation of the program commenting device may be a multimedia commenting tool (Multimedia Commenting Tool, MCT). MCT can be an integrated development environment (Integrated Development, IDE) plug-in for creating, modifying and playing multimedia annotation files, or it can be a stand-alone tool.

102. Establish an association relationship between the multimedia annotation file and the program code.

Wherein, there are two ways to establish the association relationship between the multimedia annotation file and the program code: the first is to embed the multimedia annotation descriptor corresponding to the multimedia annotation file into the program code; the second is to save the multimedia annotation file to the In the same folder as the file name of the program code. When the program maintainer reads or edits the program code, he can check the corresponding multimedia annotation file and quickly understand the program code.

Step 102 may specifically include: creating a multimedia annotation descriptor corresponding to the multimedia annotation file, and embedding the multimedia annotation descriptor into the program code. The multimedia annotation descriptor includes: the address of the multimedia annotation file and the type of the multimedia annotation file.

Wherein, when the multimedia annotation file is saved in the folder where the program code is located, the address of the multimedia annotation file may be the saving path of the multimedia annotation file. For example, when the multimedia annotation file is saved in the folder named "text.files" in the folder where the program code is located, and the name of the multimedia annotation file is "voice code", the saving path of the multimedia annotation file is "text.files :///voicecode". When the multimedia annotation file is a network resource, the address of the multimedia annotation file may be a Uniform Resource Locator (URL) corresponding to the multimedia annotation file, that is, the address of the web page where the multimedia annotation file is located.

The type of the multimedia annotation file may be in the format of audio, video, animation, still picture, text or compressed package in the multimedia annotation file. For example, the format of the audio in the multimedia annotation file can be: laser disc (COMPACTDISK, CD) format, MP3 format, musical instrument digital interface (MusicalInstrument Digital Interface, MIDI), Microsoft audio format (Windows Media Audio, WMA), instant broadcast system ( RealAudio) format, etc. The format of the video may be Motion Picture Experts Group (Motion Picture Experts Group, MPEG), Audio Video Interleaved (Audio Video Interleaved, AVI), Advanced Streaming format (Advanced Streaming format, ASF), etc. For example, when the multimedia annotation file includes audio and video, the type of the multimedia annotation file can be MP3+MPEG.

Optionally, the multimedia annotation descriptor may further include: the title of the multimedia annotation file, so that program maintainers can understand the main content of the embedded multimedia annotation file.

Optionally, the program annotation device can use the multimedia annotation descriptor as an annotation to the code part in the program code, and embed the location of the code portion; it can also use the multimedia annotation descriptor as a further annotation to the text annotation in the program code, and embed the text annotation location. The multimedia comment descriptor can start with "<<<" and end with ">>>", so that program maintainers can distinguish between program code and multimedia comment descriptor.

For example, when the user opens the program code in MCT, the user can place the cursor at the location of the code part, click the "Insert" button of MCT with the mouse, and select a video file as a multimedia comment file, and MCT can insert it according to the user's operation. The video file is embedded in the position of the code part in the display interface of the program code.

For another example, after the user opens the program code in MCT, the user can place the cursor on the position of the text comment part, click the "insert" button of MCT, and in the dialog box that appears, input the address and address of the video file as the multimedia comment file type, the MCT can insert a multimedia comment descriptor including the address and type of the video file at the position of the text comment part of the program code display interface according to the user's operation.

Optionally, the program annotation device may first embed the multimedia annotation descriptor into the program code, and then edit the multimedia annotation file corresponding to the multimedia annotation descriptor. For example, when the programmer starts to write the program code, he can use the program annotation device to create a multimedia annotation file and a corresponding multimedia annotation descriptor, and embed the multimedia annotation descriptor into the program code, and then start recording the writing process of the program code, that is, to The annotation file is edited, and when the program code is written, the recording process ends and a complete multimedia annotation file is obtained.

Optionally, the program annotation device can also edit the multimedia annotation file during the playback of the multimedia annotation file. For example, MCT can embed a video program into program code, and after running the video program, video content can be generated in real time. When the user opens the program code in the program annotation device and clicks the "play" button of the MCT, the MCT determines the video program embedded in the currently displayed program code, runs the video program, generates video content and plays the video content in real time.

Further, after step 102, when the user opens the program code in the MCT, or the IDE embedded in the MCT, and clicks the "play" button of the MCT, the MCT can regard the user's above operation as the user sending the first playback to the MCT. request, at this time, the MCT can determine the file name of the currently displayed program code according to the first play request, obtain the multimedia annotation file associated with the program code, and play the multimedia annotation file. Specifically, a Video LAN Client (VideoLAN Client, VLC) multimedia player can be used to play the multimedia annotation file, and the VLC multimedia player supports multiple audio and video encoding formats.

In this embodiment, the program annotation device uses multimedia annotation files to annotate program codes, so that program maintenance personnel can quickly understand the program codes according to the multimedia annotation files corresponding to the program codes, thereby improving the maintenance efficiency of program maintenance personnel.

Fig. 2 is a flow chart of another embodiment of the program annotation method provided by the present invention. As shown in Fig. 2, on the basis of the embodiment shown in Fig. 1, if the multimedia annotation file includes the multimedia corresponding to at least one code segment in the program code Annotate sub-files, to obtain multimedia annotation files corresponding to program codes can be:

1011. On the display interface of the program code, obtain the multimedia comment sub-file corresponding to at least one code segment in the program code, and record the operation record file, the operation record file includes the position of at least one code segment in the program code and the display interface Mouse and/or keyboard operations when the cursor is in the position corresponding to at least one code segment.

Wherein, the code segment may specifically be one line of code or multiple lines of code in the program code, or one or more characters in one line of code. The position of the code segment in the program code may specifically include a start position and an end position of the code segment in the program code.

When the cursor on the display interface is in the position corresponding to at least one code segment, the operation of the mouse may be: selecting, copying, pasting, cutting or moving the code segment or the identifier in the code segment. When the cursor on the display interface is in the position corresponding to at least one code segment, the keyboard operations may be operations such as carriage return, adding or deleting characters, and the like.

Optionally, the operation record file may also include the time when the cursor is in the position corresponding to at least one code segment. The operation record file may also include the display changes of the program code on the display interface, the display changes of the program code correspond to the operation of the mouse and/or keyboard, and are the result of the operation of the mouse and/or keyboard.

Correspondingly, the second way of establishing the association relationship between the multimedia annotation file and the program code may specifically include:

1021. Establish an association relationship among the multimedia annotation file, the operation record file, and the copy file of the program code.

The program annotation device can use the same file name plus different suffixes to store multimedia annotation files, operation record files and copy files of program codes respectively. For example, the program annotation device can save the multimedia annotation file in the form of the file name "voice Code" plus the suffix ".vcr.wav", save the operation record file in the form of the file name "voice Code" plus the suffix ". Save the copied file of the program code in the form of the name "voiceCode" plus the suffix ".vcr.java.bak".

1022. Save the multimedia annotation file, the operation record file, and the copy file of the program code in a folder whose file name is consistent with that of the program code.

For example, the program annotation device can set the file name of the program code to test.java, and save the multimedia annotation file, the operation record file and the copy file of the program code to a file whose file name is "test.java" and the suffix is ".files". in the middle.

Further, after 1022, when the user opens the program code in the MCT, or the integrated development environment IDE embedded in the MCT, on the display interface of the program code, move the cursor to the code segment that needs to view the multimedia annotation subfile in the program code and click the "seek to line" button of the MCT, the MCT can regard the user's above operation as the user sending a second playback request to the MCT, and at this time, the MCT can determine the currently displayed program according to the second playback request According to the file name of the code and the position of the code segment corresponding to the cursor in the program code, the multimedia comment file associated with the program code is obtained according to the file name of the program code, and the multimedia comment is obtained according to the position of the code segment corresponding to the cursor in the program code The operation of the mouse and/or keyboard corresponding to the code segment in the multimedia comment sub-file and the operation record file corresponding to the code segment in the file, and play the mouse and/or keyboard corresponding to the code segment in the multimedia comment sub-file and the operation record file operation.

Optionally, after 1022, when the user opens the program code in the MCT or the integrated development environment IDE embedded in the MCT, selects the identifier on the display interface of the program code, and clicks the "seek to symbol" button of the MCT , the MCT may regard the user's above operation as the user sending a third play request to the MCT. At this time, the MCT may determine the file name and identifier of the currently displayed program code according to the third play request. According to the file name of the program code , to obtain the multimedia annotation file associated with the program code, and according to the position of each code segment corresponding to the identifier in the program code, obtain the multimedia annotation sub-file corresponding to each code segment in the multimedia annotation file and the operation log file corresponding to each code segment The operation of the mouse and/or keyboard corresponding to the segment, and the multimedia annotation sub-file and the operation of the mouse and/or keyboard corresponding to the code segment in the operation record file are played sequentially in chronological order.

Wherein, the identifier may specifically be a single or multiple characters, functions, variables, or classes in the program code.

In this embodiment, the program annotation device obtains the multimedia annotation sub-file corresponding to the code segment in the program code on the display interface of the program code, and records the operation record file to create a copy file of the multimedia annotation file, the operation record file and the program code The relationship between the multimedia annotation files, operation record files, and program code copy files are saved in a folder consistent with the file name of the program code, so that program maintainers can use the multimedia annotation files corresponding to the program code, Quickly understand the program code and improve the maintenance efficiency of program maintainers.

Fig. 3 is a flowchart of another embodiment of the program annotation method provided by the present invention. As shown in Fig. 3, on the basis of the embodiment shown in Fig. 2, after step 102, it also includes:

103. When a code segment is added or deleted in the program code, determine the code segment whose position has changed in the program code, and modify the position corresponding to the code segment whose position has changed in the operation record file.

For example: in an implementation scenario, a new line of code is added after the i-th line of the program code, resulting in a change in the number of lines where the code segment after the i-th line is located, and the program annotation device needs to compare the operation record file with the i-th line The number of lines corresponding to the following code segment is increased by 1.

In the second implementation scenario, the jth line of the program code is deleted, resulting in a change in the number of lines of the code segment after the jth line, and the program annotation device needs to correspond to the code segment after the jth line in the operation record file Subtract 1 from the number of rows.

In addition, if the k-th line of the program code is modified, it can be considered as deleting the k-th line and adding a new k-th line. At this time, the position of each code segment in the program code has not changed, and there is no need to modify the operation record file. to modify.

In this embodiment, when there is an addition or deletion of a code segment in the program code, determine the code segment whose position has changed in the program code, modify the position corresponding to the code segment whose position has changed in the operation record file, and keep the operation record The consistency between the file and the program code enables the program maintenance personnel to quickly understand the program code according to the multimedia annotation file corresponding to the program code, and improves the maintenance efficiency of the program maintenance personnel.

Those of ordinary skill in the art can understand that all or part of the steps for implementing the above method embodiments can be completed by program instructions and related hardware. The aforementioned program can be stored in a computer-readable storage medium. When the program is executed, it executes the steps including the above-mentioned method embodiments; and the aforementioned storage medium includes: ROM, RAM, magnetic disk or optical disk and other various media that can store program codes.

Fig. 4 is a schematic structural diagram of an embodiment of the program annotation device provided by the present invention, as shown in Fig. 4, including:

Obtaining module 41, is used for obtaining the multimedia annotation file corresponding to program code;

The establishment module 42 is used to establish the association relationship between the multimedia annotation file and the program code.

Optionally, the first way for the establishment module 42 to establish the association between the multimedia annotation file and the program code may be to create a multimedia annotation descriptor corresponding to the multimedia annotation file, and embed the multimedia annotation descriptor into the program code. Wherein, the multimedia annotation descriptor includes: the address of the multimedia annotation file and the type of the multimedia annotation file.

Further, the program annotation device may further include: a receiving module and a playing module. Receiving module is used for, after setting up module 42 to set up the associative relationship between multimedia note file and program code, receives the user's first play request; File name, play the multimedia annotation file associated with the program code.

Optionally, the multimedia annotation file includes a multimedia annotation sub-file corresponding to at least one code segment in the program code, and correspondingly, the acquisition module 41 is specifically used to acquire the subfile corresponding to at least one code segment in the program code on the display interface of the program code. The multimedia annotation sub-file, and record the operation record file, the operation record file includes the position of at least one code segment in the program code and the mouse and/or keyboard operation when the cursor is in the corresponding position of at least one code segment on the display interface.

Correspondingly, the establishment module 42 is specifically used to set up the association relationship between the duplicate files of the multimedia annotation file, the operation record file and the program code; the duplicate file of the multimedia annotation file, the operation record file and the program code is saved to the folder with the same file name.

Further, the program annotation device may also include: a modification module, used to determine the code segment whose position in the program code changes when there is an addition or deletion of a code segment in the program code, and modify the code segment whose position changes in the operation record file Modify the position corresponding to the segment.

Furthermore, the receiving module can also be used to receive the user's second play request after the establishment module 42 establishes the association between the multimedia annotation file and the program code; the playing module can also be used to determine the file of the currently displayed program code Name and the position of the code segment corresponding to the cursor in the program code, according to the file name of the program code, obtain the multimedia comment file associated with the program code, and according to the position of the code segment corresponding to the cursor in the program code, obtain the multimedia comment file associated with the code Multimedia annotation subfile corresponding to the segment and the operation of the mouse and/or keyboard corresponding to the code segment in the operation record file; operate.

Optionally, the receiving module can also be used to receive the user's third play request after the establishment module 42 establishes the association between the multimedia annotation file and the program code; the play module can also be used to determine the currently displayed program code The file name and identifier of the program code, according to the file name of the program code, obtain the multimedia annotation file associated with the program code, obtain the position of each code segment corresponding to the identifier in the program code, and obtain the position of each code segment corresponding to the identifier in the program code. position in the program code, obtain the multimedia annotation subfile corresponding to each code segment in the multimedia annotation file, and the operation of the mouse and/or keyboard corresponding to each code segment in the operation record file, and play the multimedia annotation subfile corresponding to the code segment , mouse and/or keyboard actions.

In this embodiment, the program annotation device uses multimedia annotation files to annotate program codes, so that program maintenance personnel can quickly understand the program codes according to the multimedia annotation files corresponding to the program codes, thereby improving the maintenance efficiency of program maintenance personnel.

Finally, it should be noted that: the above embodiments are only used to illustrate the technical solutions of the present invention, rather than limiting them; although the present invention has been described in detail with reference to the foregoing embodiments, those of ordinary skill in the art should understand that: It is still possible to modify the technical solutions described in the foregoing embodiments, or perform equivalent replacements for some or all of the technical features; and these modifications or replacements do not make the essence of the corresponding technical solutions deviate from the technical solutions of the various embodiments of the present invention. scope.

Claims (9)

1. A method for program annotation, characterized in that, comprising: Obtain a multimedia annotation file corresponding to the program code; An association relationship between the multimedia annotation file and the program code is established. 2. The method according to claim 1, wherein the setting up of the association between the multimedia annotation file and the program code comprises: Create the multimedia annotation descriptor corresponding to the multimedia annotation file, the multimedia annotation descriptor includes: the address of the multimedia annotation file and the type of the multimedia annotation file; Embedding the multimedia annotation descriptor in the program code. 3. The method according to claim 1, wherein the multimedia annotation file includes a multimedia annotation subfile corresponding to at least one code segment in the program code; the multimedia annotation file corresponding to the program code is obtained, comprising : On the display interface of the program code, obtain the multimedia annotation sub-file corresponding to at least one code segment in the program code, and record the operation record file, the operation record file includes the at least one code segment in the program The position in the code and the mouse and/or keyboard operation when the cursor on the display interface is in the position corresponding to the at least one code segment. 4. The method according to claim 3, wherein said setting up the association relationship between said multimedia annotation file and said program code comprises: establishing an association between the multimedia annotation file, the operation record file, and the copy file of the program code; The multimedia annotation file, the operation record file and the copy file of the program code are saved in a folder with the same file name as the program code. 5. The method according to claim 4, characterized in that, after establishing the association between the multimedia annotation file and the program code, further comprising: When there is an addition or deletion of a code segment in the program code, determine the code segment whose position has changed in the program code, and modify the position corresponding to the code segment whose position has changed in the operation record file. 6. The method according to any one of claims 1-5, further comprising: receiving the user's first playback request; Determine the file name of the currently displayed program code; According to the file name of the program code, the multimedia annotation file associated with the program code is played. 7. The method according to any one of claims 3-5, further comprising: receiving the user's second play request; Determine the file name of the currently displayed program code and the position of the code segment corresponding to the cursor in the program code; Acquiring a multimedia annotation file associated with the program code according to the file name of the program code; According to the position of the code segment corresponding to the cursor in the program code, obtain the multimedia annotation sub-file corresponding to the code segment in the multimedia annotation file and the mouse and mouse corresponding to the code segment in the operation record file / or keyboard operation; Play the multimedia annotation sub-file corresponding to the code segment, the operation of the mouse and/or keyboard. 8. The method according to any one of claims 3-5, further comprising: receiving the user's third play request; Determine the file name and identifier of the currently displayed program code; Acquiring a multimedia annotation file associated with the program code according to the file name of the program code; Acquiring the position of the code segment corresponding to the identifier in the program code; According to the position of the code segment corresponding to the identifier in the program code, obtain the multimedia comment sub-file corresponding to the code segment in the multimedia comment file and the sub-file corresponding to the code segment in the operation record file mouse and/or keyboard operation; Play the multimedia annotation sub-file corresponding to the code segment, the operation of the mouse and/or keyboard. 9. A program annotation device, characterized in that it comprises: An acquisition module, configured to acquire a multimedia annotation file corresponding to the program code; The establishment module is used to establish the association relationship between the multimedia annotation file and the program code.

Images