跳轉到內容

Perlwikibot/貢獻

來自華夏公益教科書

Perlwikibot 是一個開源專案,旨在建立一個完整的框架,以便快速建立和部署計算機程式,這些程式可以執行 MediaWiki 維基上的常見重複任務。這些客戶端通常被稱為“機器人” - 因此得名該專案。

您可以幫助修復錯誤或為框架新增新功能。程式碼是根據 GNU 通用公共許可證授權的。簡而言之,這意味著任何人都可以將程式碼用於任何目的,包括商業用途,以及製作和分發修改後的版本,只要他們提供歸屬資訊,並且所有派生版本也都在 GPL 下獲得授權。

程式碼風格

[編輯 | 編輯原始碼]

Perl 程式碼本身就很難閱讀,所以請努力編寫可讀的程式碼。

無論何時程式碼執行了不明顯的操作,都應包含註釋。

不好
sub foo {
    my $param = shift; # Take the first param
    my @args = @_;     # Take the remaining elements, if any
}
很好
sub bar {
    my $param = shift; # The page to edit
    my @args  = @_;    # Contains any other settings (for example, whether to mark the edit as minor)
}

Perltidy 是一個程式碼縮排器和格式化程式。您可以使用它來幫助清理您的 Perl 程式碼。對於 perlwikibot,請使用

-syn    # Syntax check input and output
-b      # Backup and modify in-place
-l=78   # Max line width is 78 cols
-i=4    # Indent level is 4 cols
-ci=4   # Continuation indent is 4 cols
-vt=0   # Minimum vertical tightness
-vtc=0  # Minimum vertical tightness closing
-cti=0  # No extra indentation for closing brackets
-pt=2   # Maximum parenthesis tightness
-sbt=2  # Maximum square bracket tightness
-bt=1   # Medium brace tightness
-nsfs   # No space before semicolons
-nolq   # Don't outdent long quoted strings
-boc    # Break at old comma breakpoints
-bbs    # Blank line before subs
-sot    # Stack opening tokens
-sct    # Stack closing tokens
-bbao   # Break before all operators

您可以將它放在 .perltidyrc 中,它們將在每次使用 perltidy 時使用。將該檔案放在您的工作目錄中以僅應用於該目錄,或者放在您的 $HOME 中以對所有內容使用這些設定。

或者,將每個選項設定為 perltidy 的命令列選項

user@host:~$ perltidy -syn -b -l=78 ...

Mike 將他的 git 倉庫推送到 github;要做出貢獻,請建立一個分支,進行更改,並建立一個新的 拉取請求

華夏公益教科書