ソースコメントってものがある。

プログラムソース内に記述する説明文のことだ。

昔のC言語だと、
/*　ここにコメント記述 */

VBだと
'　ここにコメント記述

C#とかだと、
//　ここにコメント記述

PL/Sqlだと
--　ここにコメント記述

って感じ。
緑色の部分が、コメントであることを示す記号である。

他人のソースを見なくてはならないとき、
コメントはとても有用な手がかりだ。
・・・本当のことが書いてあるならば。

結構このコメントを適当に扱う人も多いので、
コメントだけ読んでると嘘八百ということもままある。

今の上司も、そういうタイプ。

その上司が作ったソースのコメントを、
英語化する羽目に陥った。

客先DBがシングルバイト環境であるため、
「今のままだとコメントが文字化けしてツールから見られない」
という指摘があったのだ。

仕方ないなぁということで、私が修正することになってしまった。

これが、とてもやっかいな作業で。

第一に、あの上司のコメントが正しいのか？
という検証からはじめなくてはならない。

第二に、内容は正しくても適切なコメントか？
を判定しなくてはならない。

そして、第三に、適切な英語になおす必要がある。

なんかもう疲れてしまった。
内容が、理系知識を必要とするものだから、なおさら。




今後のためにも、適当にWEBから英語コメントを拾ってきてみた。
上の２ブロックは、OracleのサイトからとってきたPL/SQLコメントとJavaコメント。
最後のブロックは、サンプルコードを公開してるVBサイトからのコメント。
ま、書き方も色々だよね。

-- This statement adds a check constraint which does a check on the password format.
-- This uses a regular expression to check if the password is alpha-numeric or not.
-- Insert data into the userinfo table
-- Declare a cursor that fetches users with hobbies related either to football or baseball.
-- This retrieves the location of all the users in the database.
-- Open the cursor
-- Loop through the cursor and print the selected values
-- Exit the loop when there are no more records in the cursor
-- Close the cursor
-- If the input values is other than 1,2 and 3 then print an error message

// Create an instance of this class
// Load the properties file to get the connection information from the Connection.properties file
// Set Database SID
// Loads a ResourceBundle and creates Properties from it
// Prepare to execute the stored procedure CHECK_PASSWORD
// Add the user into the database.
// Retrieve the OUT parameters
// Bind the values
// Declare the form elements
// Register the action listener for the button click event
// Get the user input values from the form
// Check if both the passwords match.
// Display an error message.
// Set the message in the error field.

'Get a free file handle
'If the file is not there, one will be created
'If the file does exist, this one will overwrite it.
'Trim out unused characters from the string.
'Get the length of the file and read it into the text box
'Append a backslash if one does not exist
'Loop backwards through msFullPath until we have all of the filename
'Parse out the path without the filename
'Get the extension
'Check to see if there was an error

一番上の
-- This statement adds a check constraint which does a check on the password format.
って長すぎると思うんだけど。
ま、これはOracleがユーザ向けに公開してる奴だから親切仕様なのだろう。
私が日本語で書くなら、
-- パスワードフォーマットチェック制約追加
かな。

-- If the input values is other than 1,2 and 3 then print an error message
の”input values is”って間違いじゃないのか？

ま、そんなこんなで、
今後は自分でプログラミングするときも、
英語コメントだとどうなるのかを意識するようにしてみよう。