到目前为止,最好的方法是将所有代码都包括在内作为补充材料。如果可能,还包括带有重新生成结果所需的随机种子的文件。这不仅使人们可以重新创建您的结果(您可能并不在意),还可以使他们更轻松地继续您的工作。这样可以为您的工作提供新的协作和引用。不幸的是,这带来了迫使您清理代码并确保其无bug的困难。因此,它比实际中的理想状态更为理想。但是至少,您应该存档用于生成结果的代码版本,这样,如果另一个研究人员要求提供代码,则可以生成它。
关于您的论文中的描述,然后我将集中于模型的关键新颖特征的高级,独立于实现的描述(这是大多数优秀论文所实现的实际部分)。专注于可以对结果进行定性改变的特征。我使用的大多数模型都会产生定量结果,但是通常不关心具体数量,而只是定性行为(因为参数通常与自然界中可观察到的参数相距甚远)。因此,我专注于描述模型的各个部分,如果这些部分发生变化,则会改变系统的定性行为。如果这种心态迫使我描述模型的每个细节到实现,那么我知道我的模型不是很健壮,因此应该废弃。
测试您的书面说明是否足够的一个好方法是,请没有与您一起完成此项目的朋友(或学生)描述他们如何实现模型是伪代码。如果他们在尝试时没有卡住(因为他们得出的模型草图应该产生相同的定性结果),那么您就知道您做得很好。