Wenn die Autoren einen Link zu ihrem Code als Referenz angegeben haben, ist es angebracht, einen Kommentar abzugeben, insbesondere wenn der Artikel auf dem Code basiert.

Ich würde jedoch empfehlen, die Kritik zu äußern konstruktiv: Bieten Sie konkrete Vorschläge zur Verbesserung an, anstatt nur zu sagen, dass es „chaotisch“ oder „schlampig“ ist und „aufgeräumt“ werden muss.

Der Kodex fällt in den Rahmen der Überprüfung, und es ist angebracht, dies zu überprüfen und konstruktive Vorschläge in Bezug auf seine Mängel zu unterbreiten. Denken Sie jetzt daran, dass es die Pflicht des Autors ist, die Prüfer mit ihrem Argument zufrieden zu stellen. Wenn das Argument von Computercode abhängt, der so chaotisch ist, dass er nicht lesbar ist, müssen Sie dies nicht für sie beheben. In diesem Fall kann sich ein konstruktiver Rat darauf beschränken, zu erklären, warum es derzeit zu schwer zu lesen ist (d. H. Fehlende Einrückung, unklare Variablennamen usw.), und dies könnte vernünftigerweise zu einer Empfehlung zur Überarbeitung und erneuten Einreichung führen. Versuchen Sie klar und umfassend zu beschreiben, warum der Code derzeit schwer zu lesen ist, sodass zu erwarten ist, dass nachfolgende erneute Einreichungen auf dem neuesten Stand sind.

In diesen Fällen ist es am besten, den Code zu behandeln Computercode genau wie die Prosa in der Zeitung. Genau wie bei der Prosa muss der Computercode im Verhältnis zu den Codierungsstandards klar und verständlich sein. Wenn es unordentlich und unverständlich ist, muss es überarbeitet werden, bis es klar ist. Rezensenten scheuen sich nicht, Papiere abzulehnen, wenn die Prosa unverständlich ist. Es ist daher durchaus vernünftig, die Verständlichkeit von Computercode zu verlangen.

Ja, Sie sollten Kommentare abgeben und möglicherweise mehr.

Sie haben es selbst gesagt:

Viele Ergebnisse in diesem Artikel hängen stark von Computerberechnungen ab.

Nun, der Programmcode für Berechnungen ist daher Teil der Arbeit, die Sie überprüfen. Wenn der Text des Papiers schwer zu lesen wäre, würden Sie das nicht als Schwäche betrachten? Logischerweise gilt dies auch für den Code (auch wenn dies in etwas geringerem Umfang der Fall ist).

Auch wenn der Code für Sie nicht lesbar ist, gibt es möglicherweise Fehler, trotz der soliden Mathematik unterhalb. Und schließlich, wenn Sie sagen können, was die Ergebnisse ohne den Code sein sollten, warum dann überhaupt den Code?

Wenn Sie also das Gefühl haben, dass die Unordnung das "Parsen" des Papiers nicht ausschließt, kommentieren Sie es (Und wenn möglich, stufen Sie es von Strong Accept auf Weak Accept herab, obwohl dies möglicherweise zu hart ist - hängt von den Besonderheiten ab.)

Wenn Sie den Code genau zu den Ergebnissen lesen müssen, und Sie einfach kann nicht, dann ist das ein ernstes Problem. Bevor Sie jedoch etwas wie "Überarbeitung erforderlich" sagen, wenden Sie sich an den Herausgeber der Zeitschrift / den Vorsitzenden des Programmausschusses / usw.

_{Hinweis: Ich bin Informatiker, daher ist meine Antwort möglicherweise etwas voreingenommen. Andererseits habe ich rein theoretisches Papier ohne Code geschrieben. Sub>}

Unordentlicher Code beeinträchtigt die Reproduzierbarkeit

Sie haben versucht, die Ergebnisse mit dem verknüpften Code zu reproduzieren, konnten dies jedoch nicht. Während Sie implizieren, dass Sie letztendlich in der Lage waren, Ihren eigenen Code zu entwickeln und die Ergebnisse zu replizieren, argumentiere ich, dass schlecht geschriebener Code die Reproduzierbarkeit beeinträchtigt. In der Computerprogrammierung kann dies sogar noch wichtiger sein, da Programmiersprachen nicht unbedingt eine sehr lange Lebensdauer haben. Wer weiß, ob Magma oder eine andere Sprache in 50 Jahren allgemein bekannt sein wird.

Auf lange Sicht ist die Reproduzierbarkeit der wichtigste Teil des wissenschaftlichen Bestrebens. Der Beweis, dass a zu b führt, eine Tatsache, die von jedem, der es versuchen möchte, erneut bewiesen werden kann, ist ein axiomatischer Baustein, auf dem weitere wissenschaftliche Ergebnisse beruhen können.

Wenn die Reproduzierbarkeit wichtig ist, ist es nichts Falsches, wenn Sie ihnen sagen, dass sie ihren Code bereinigen sollen. Ehrlich gesagt, wenn ihr Code so schlecht ist, wie Sie es beschreiben, werden die Autoren in einigen Jahren Probleme haben, ihre eigene Arbeit zu verstehen, die darauf zurückgeht. In diesem Fall würden Sie ihnen einen Gefallen tun, wenn Sie sie dazu zwingen, etwas über das Schreiben von nettem Code zu lernen.

Lassen Sie mich kurz auf einen Aspekt eingehen, der in den vorhandenen Antworten nicht enthalten ist.

Meine Frage ist, ob es für mich vernünftig ist, den Autoren zu sagen, dass ihr Code unnötig schwierig ist verstehen und verbessert werden?

Ja , Sie sollten den Code kommentieren, aber nicht nur das: überzeugen Sie die Autoren, dass er in sich selbst ist -interesse, um diese Probleme zu beheben.

Lesbarer Code ist Code, der leicht wiederzuverwenden ist. Wiederverwendbarer Code ist Code, der es einfach macht, die in diesem Artikel vorgestellte Mathematik zu erkunden. Erkundbare Mathematik hat eher Leser, die interessante Erweiterungen finden. Interessante Erweiterungen werden veröffentlicht, und diese Veröffentlichungen zitieren den Originalcode - und bieten darüber hinaus einige der wertvollsten Zitate.

Wenn Sie Ihren Code lesbar und wiederverwendbar machen, ist dies keine Garantie dafür, aber wenn Sie dies tun Veröffentlichen Sie unlesbaren Code. Sie stellen eine künstliche Barriere vor einen Leser, der möglicherweise weitere Untersuchungen auf der Grundlage Ihrer Arbeit durchführt oder nicht. Wenn es genügend solche Barrieren gibt, wendet sich dieser Leser einfach an eine andere Stelle. Das Lesen des Codes ist ein bescheidener Zeitaufwand, der zu einer erheblichen Verbesserung der Erweiterbarkeit der Arbeit führt.

Das Aufstellen von Barrieren ist natürlich nicht nur auf Code beschränkt: unklar Zahlen, verworrene Strukturen, chaotische Grammatik, fehlende Deckspelzen und alle möglichen anderen Probleme können ähnliche Hindernisse darstellen, und Ihre Aufgabe als Rezensent besteht darin, darauf hinzuweisen und den Autoren dabei zu helfen, sie loszuwerden. Code ist nicht anders - helfen Sie ihnen, ihn zu verbessern!

Ich bin nicht in der akademischen Welt oder ein Rezensent von Artikeln / Artikeln auf dieser Ebene (zusätzlich an der Tech-Schule), aber ich benote viele Programmier-Hausaufgaben und das eine oder andere Beispiel für technische Dokumente und mache Software-Entwicklung, um tatsächlich zu bezahlen Die Rechnungen.

Wenn das Papier von der Ausgabe des generierten Codes abhängt, muss der Code lesbar und verständlich sein. Andernfalls kann der Code möglicherweise nicht das tun, was der Autor glaubt, und es ist für andere unmöglich, w / zu bestätigen o ihre eigene Neuimplementierung. Wenn eine solche Neuimplementierung relativ trivial ist, scheint der eigentliche Code nicht wichtig zu sein, und ich würde mich fragen, warum fehlerhafter Code für etwas, das auf der Grundlage von Spezifikationen einfach zu implementieren ist, in einem wissenschaftlichen Artikel enthalten oder referenziert wird.

Da Sie in der Lage waren, die Implementierung seiner Algorithmen mithilfe Ihrer eigenen Code-Implementierung zu überprüfen, denke ich nicht, dass dies der Fall ist, aber dies sollte berücksichtigt werden. Jede anständige IDE oder sogar jeder erweiterte Texteditor sollte in der Lage sein, Code automatisch zu formatieren und projektweit zu suchen / ersetzen (Refactoring). Ein bisschen deutet auf Faulheit hin ....

Die Autoren geben im Artikel einen Link an, sodass der Code entweder als Referenz oder als Teil der Forschung betrachtet wird. Unabhängig von der Situation wirft dies Fragen auf:

1. Ist der Code archiviert? Zu den praktischen Möglichkeiten zum Archivieren von Code gehören Zenodo oder figshare. Code auf einer Homepage ist so gut wie gar kein Code.
2. Gibt es eine Lizenz für den Code? Wenn nicht, ist sein Status überhaupt nicht ersichtlich.
ol>

Als Prüfer liegt es an Ihnen, zu entscheiden, was zu tun ist. Mögliche Aktionen sind:

1. Kommentieren Sie den Code nicht.
2. Kommentieren Sie den Code mit dem, was ich als Minimum bezeichnen würde: Voraussetzung ist, dass der Code ordnungsgemäß archiviert und lizenziert wird
3. Abhängig von der Bedeutung des Computerprogramms für die Forschung ist eine minimale Lesbarkeit erforderlich, und der Autor stellt einige Tests für das Programm bereit (dh, das Programm liefert bekannte analytische Antworten, wenn einige Parametersätze dies zulassen it usw.).
ol>

Bezüglich der Archivierung können Sie auf die redaktionellen Informationen des Journal of Open Research Software verweisen.

Ich bin Softwareentwickler und möchte die Frage aus dieser Perspektive beantworten. Der meiste Code ist an sich nicht lesbar. Sie benötigen einen Kommentar, um Datenstrukturen und Spezifikationen für Unterprogrammaufrufe zu dokumentieren. Akademiker sind keine Software-Ingenieure, und ich erwarte nicht, dass sie diesbezüglich einen professionellen Job machen. Dennoch ist es sicherlich, um die Qualität der Software zu kommentieren. Ohne den tatsächlichen Code zu betrachten, bin ich mir nicht sicher, ob ich sagen würde, dass er nicht lesbar ist, da der Artikel (der laut Aussage ausreicht, um den Code zu reproduzieren) als Teil der Programmdokumentation anzusehen ist. Wenn das Programm Kurznamen verwendet, die mit denen im Papier identisch sind, ist dies kein Problem. Fehlende Einrückungen sind kein Hinweis auf eine schlechte Qualität, aber viele Einrückungsstufen sind vorhanden. Ich würde vorschlagen, dass Sie Ihr Gefühl ausdrücken, dass Sie Schwierigkeiten beim Lesen haben, aber auch kein Code-Experte sind und sich vielleicht von einem Software-Ingenieur das ansehen lassen. Es ist eine andere Fähigkeit, die Sie kennen. Das sollte den Kommentar abschwächen.

Um das Ganze abzurunden: Ich habe gute Arbeit bei der Bereinigung von Code geleistet, die ich auf der Zielebene nicht verstanden habe. Sie werden überrascht sein, wozu ein Experte auf einem anderen Gebiet in der Lage ist.

Unterm Strich ist der Code nicht von entscheidender Bedeutung, die Qualität des Codes ist zufällig und sollte Ihre Entscheidung in keiner Weise beeinflussen.

Meines Wissens nach reichen die Autoren den Code nicht zur Veröffentlichung ein, sodass der Code anscheinend nicht Ihrer Überprüfung unterliegt. Die Autoren geben lediglich einen Link zu ihrem Code. Dies wirft die Frage auf: Wenn sie nur einen Verweis auf ihre an anderer Stelle veröffentlichte Arbeit gegeben hätten, hätten Sie darüber nachgedacht, ihnen zu sagen, dass diese Arbeit verbessert werden sollte? Man kann argumentieren, dass die Gültigkeit ihrer Ergebnisse von der Richtigkeit ihres Codes abhängt, aber sie könnten sich dafür entscheiden, überhaupt keinen Zugriff auf den Code zu gewähren, da "die diesen Berechnungen zugrunde liegende Mathematik so gut erklärt wird, dass es möglich ist, die Ergebnisse ohne zu reproduzieren." unter Verwendung des Autorencodes ". Sie als Prüfer haben sich die Mühe gemacht, die Ergebnisse ihrer Berechnung zu überprüfen und damit über Ihre Pflicht hinauszugehen. Dies bedeutet jedoch, dass ihre Ergebnisse tatsächlich reproduzierbar sind.

Ich würde also denken, dass Sie dies erwähnen könnten dass ihr Code mies ist (obwohl er anscheinend korrekt ist), aber das sollte Ihre Empfehlung zum Veröffentlichen / Nichtveröffentlichen des Papiers nicht beeinflussen.

Mir sind keine wissenschaftlichen Zeitschriften bekannt, deren Entscheidungen auf dem Kodex beruhen. Ob es chaotisch ist oder nicht, ist kein Problem in Bezug auf das Tagebuch. Dass es reproduzierbar sein sollte, sollte ein Problem sein, aber mir sind keine Zeitschriften bekannt, die dies zu einem Kriterium machen, außer einer Initiative für einige Gemeinschaften, z. NIPS, CVPR. Meiner Meinung nach ist es bereits ein Bonus, dass sie sich entschieden haben, es freizugeben (und in einigen Fällen dürfen die Leute sie aufgrund der Regeln ihrer Organisation nicht einmal freigeben). Wenn Sie behaupten, dass der Code nicht korrekt ist oder nicht das tut, was er tun soll, ist dies möglicherweise eine andere Geschichte, aber Sie müssen dies begründen. Wenn Sie nur einen Kommentar zur Schlamperei des Codes abgeben möchten, sollten Sie Ihren Kommentar klarstellen und betonen, dass er keinen Einfluss auf die Gesamtbewertung hat. Ich stimme einem zuvor gemachten Kommentar zu, "überzeugen Sie die Autoren, dass er in ihrem enthalten ist." Eigeninteresse, um diese Probleme zu beheben. " Machen Sie einfach bekannt, dass Ihr Kommentar zum Code nicht mit der Überprüfung des Papiers zusammenhängt. Bitte entmutigen Sie auch nicht Leute, die ihren Code veröffentlichen, auch wenn er "chaotisch" ist.